pypureclient.flasharray.FA_2_36.api package

Submodules

pypureclient.flasharray.FA_2_36.api.active_directory_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.active_directory_api.ActiveDirectoryApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_active_directory_delete_with_http_info(names: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, local_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

Delete Active Directory account # noqa: E501

Deletes one or more specified Active Directory accounts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_active_directory_delete_with_http_info(names, authorization, x_request_id, local_only, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• local_only (bool) – If specified as true, only delete the Active Directory configuration on the local array, without deleting the computer account created in the Active Directory domain. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_active_directory_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List Active Directory accounts # noqa: E501

Displays configured Active Directory accounts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_active_directory_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ActiveDirectoryGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_active_directory_patch_with_http_info(names: ConstrainedListValue[StrictStr], active_directory: ActiveDirectoryPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify Active Directory account # noqa: E501

Modifies specified Active Directory account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_active_directory_patch_with_http_info(names, active_directory, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• active_directory (ActiveDirectoryPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ActiveDirectoryResponse, status_code(int), headers(HTTPHeaderDict))

api236_active_directory_post_with_http_info(names: ConstrainedListValue[StrictStr], active_directory: ActiveDirectoryPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, join_existing_account: Optional[StrictBool] = None, **kwargs) → ApiResponse

Create Active Directory account # noqa: E501

Creates one or more Active Directory accounts. The user and password provided are used to join the array to the specified domain. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_active_directory_post_with_http_info(names, active_directory, authorization, x_request_id, join_existing_account, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• active_directory (ActiveDirectoryPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• join_existing_account (bool) – If specified as true, the domain is searched for a pre-existing computer account to join to, and no new account will be created within the domain. The user specified when joining a pre-existing account must have permissions to ‘read all properties from’ and ‘reset the password of’ the pre-existing account. join_ou will be read from the pre-existing account and cannot be specified when joining to an existing account. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ActiveDirectoryResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.administrators_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.administrators_api.AdministratorsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_admins_api_tokens_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete API tokens # noqa: E501

Deletes the API tokens of the specified administrators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_api_tokens_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_admins_api_tokens_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, expose_api_token: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List API tokens # noqa: E501

Displays API tokens for the specified administrators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_api_tokens_get_with_http_info(authorization, x_request_id, continuation_token, expose_api_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• expose_api_token (bool) – If true, exposes the API token of the current user.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminApiTokenGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_admins_api_tokens_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, timeout: Optional[StrictInt] = None, **kwargs) → ApiResponse

Create API tokens # noqa: E501

Creates API tokens for the specified administrators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_api_tokens_post_with_http_info(authorization, x_request_id, names, timeout, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• timeout (int) – The duration of API token validity, in milliseconds.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminApiTokenResponse, status_code(int), headers(HTTPHeaderDict))

api236_admins_cache_delete_with_http_info(remove_all_entries: StrictBool, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Delete cache entries # noqa: E501

Deletes all entries from the administrator cache. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_cache_delete_with_http_info(remove_all_entries, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• remove_all_entries (bool) – If set to true, removes all entries from the administrator cache. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_admins_cache_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List administrator cache entries # noqa: E501

Displays entries in the administrator cache. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_cache_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminCacheGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_admins_cache_put_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Update or refresh entries in the administrator cache # noqa: E501

Updates entries in the cache for administrators who currently do not have a cache entry, otherwise refreshes the existing entry. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_cache_put_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminCacheResponse, status_code(int), headers(HTTPHeaderDict))

api236_admins_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete an administrator # noqa: E501

Deletes the specified administrator. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_admins_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, expose_api_token: Optional[StrictBool] = None, expose_public_key: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List administrators # noqa: E501

Displays a list of administrators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_get_with_http_info(authorization, x_request_id, continuation_token, expose_api_token, expose_public_key, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• expose_api_token (bool) – If true, exposes the API token of the current user.

• expose_public_key (bool) – If true, exposes the public key of the current user.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_admins_patch_with_http_info(admin: AdminPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify an administrator # noqa: E501

Modifies properties for the specified administrator. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_patch_with_http_info(admin, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• admin (AdminPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminResponse, status_code(int), headers(HTTPHeaderDict))

api236_admins_policies_management_access_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a membership between an administrator and one or more management access policies # noqa: E501

Deletes a membership between an administrator with one or more management access policies. The`policy_ids` or policy_names is required, but they cannot be set together. The member_ids or member_names is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_policies_management_access_delete_with_http_info(authorization, x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_admins_policies_management_access_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List management access policies attached to administrators # noqa: E501

Displays a list of management access policies that are attached to administrators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_policies_management_access_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberCleanGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_admins_policies_management_access_post_with_http_info(policies: PolicyAssignmentPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between an administrator with one or more management access policies. # noqa: E501

Creates a membership between an administrator with one or more management access policies. The member_ids or member_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_policies_management_access_post_with_http_info(policies, authorization, x_request_id, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• policies (PolicyAssignmentPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberCleanResponse, status_code(int), headers(HTTPHeaderDict))

api236_admins_post_with_http_info(admin: AdminPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create an administrator # noqa: E501

Creates an administrator. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_post_with_http_info(admin, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• admin (AdminPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminResponse, status_code(int), headers(HTTPHeaderDict))

api236_admins_settings_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List administrator settings # noqa: E501

Displays the global administrator settings for the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_settings_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminSettingsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_admins_settings_patch_with_http_info(admin_settings: AdminSettings, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify administrator settings # noqa: E501

Modifies the global administrator settings for the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_admins_settings_patch_with_http_info(admin_settings, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• admin_settings (AdminSettings) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AdminSettingsResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.alert_watchers_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.alert_watchers_api.AlertWatchersApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_alert_watchers_delete_with_http_info(names: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Delete alert watcher # noqa: E501

Delete alert watcher email address from the list of alert watchers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alert_watchers_delete_with_http_info(names, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_alert_watchers_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List alert watchers # noqa: E501

Displays alert watcher email addressess and indicates whether they are enabled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alert_watchers_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertWatcherGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_alert_watchers_patch_with_http_info(names: ConstrainedListValue[StrictStr], alert_watcher: AlertWatcherPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify alert watcher # noqa: E501

Modify alert watcher email address by enabling or disabling it. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alert_watchers_patch_with_http_info(names, alert_watcher, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• alert_watcher (AlertWatcherPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertWatcherResponse, status_code(int), headers(HTTPHeaderDict))

api236_alert_watchers_post_with_http_info(names: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, alert_watcher: Optional[AlertWatcherPost] = None, **kwargs) → ApiResponse

Create alert watcher # noqa: E501

Creates one or more alert watcher email addresses, adding them to the list of alert watchers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alert_watchers_post_with_http_info(names, authorization, x_request_id, alert_watcher, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• alert_watcher (AlertWatcherPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertWatcherResponse, status_code(int), headers(HTTPHeaderDict))

api236_alert_watchers_test_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List alert watcher test # noqa: E501

Displays alert watcher email test results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alert_watchers_test_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.alerts_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.alerts_api.AlertsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_alerts_events_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, flagged: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List alert events # noqa: E501

Displays a list of alert events. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alerts_events_get_with_http_info(authorization, x_request_id, continuation_token, filter, flagged, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• flagged (bool) – If set to true, lists only flagged messages. If set to false, lists only unflagged messages. if not specified, lists all messages.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertEventGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_alerts_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, flagged: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List alerts # noqa: E501

Displays a list of alerts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alerts_get_with_http_info(authorization, x_request_id, continuation_token, filter, flagged, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• flagged (bool) – If set to true, lists only flagged messages. If set to false, lists only unflagged messages. if not specified, lists all messages.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_alerts_patch_with_http_info(alert: Alert, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify flagged state # noqa: E501

Modifies one or more alerts and display updated information about these alerts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alerts_patch_with_http_info(alert, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• alert (Alert) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertResponse, status_code(int), headers(HTTPHeaderDict))

api236_alerts_rules_catalog_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, code: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List available customizable alert codes # noqa: E501

Displays a list of available customizable alert codes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alerts_rules_catalog_get_with_http_info(authorization, x_request_id, code, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• code (int) – The alert code to display.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertRulesCatalogGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_alerts_rules_delete_with_http_info(code: StrictInt, parameter: StrictStr, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Delete a custom alert rule # noqa: E501

Deletes a custom alert rule. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alerts_rules_delete_with_http_info(code, parameter, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• code (int) – The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog. (required)

• parameter (str) – The parameter of the custom alert rule to modify. Values include info and warning. Available parameter values can be found in the alert rules catalog. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_alerts_rules_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, code: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List custom alert rules # noqa: E501

Displays a list of custom alert rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alerts_rules_get_with_http_info(authorization, x_request_id, code, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• code (int) – The alert code to display.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertRulesGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_alerts_rules_patch_with_http_info(code: StrictInt, parameter: StrictStr, alert_rule: AlertRules, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify a custom alert rule # noqa: E501

Modifies a custom alert rule to a new value. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alerts_rules_patch_with_http_info(code, parameter, alert_rule, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• code (int) – The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog. (required)

• parameter (str) – The parameter of the custom alert rule to modify. Values include info and warning. Available parameter values can be found in the alert rules catalog. (required)

• alert_rule (AlertRules) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertRulesResponse, status_code(int), headers(HTTPHeaderDict))

api236_alerts_rules_post_with_http_info(code: StrictInt, parameter: StrictStr, alert_rule: AlertRules, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create a custom alert rule # noqa: E501

Creates an alert rule with a custom value. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_alerts_rules_post_with_http_info(code, parameter, alert_rule, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• code (int) – The alert code that the rule applies to. Available alert codes for customization can be found in the alert rules catalog. (required)

• parameter (str) – The parameter of the custom alert rule to modify. Values include info and warning. Available parameter values can be found in the alert rules catalog. (required)

• alert_rule (AlertRules) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AlertRulesResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.api_clients_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.api_clients_api.APIClientsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_api_clients_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete an API client # noqa: E501

Deletes an API client. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_api_clients_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_api_clients_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List API clients # noqa: E501

Displays a list of API clients. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_api_clients_get_with_http_info(authorization, x_request_id, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ApiClientGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_api_clients_patch_with_http_info(api_clients: ApiClientPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Manage an API client # noqa: E501

Enables or disables an API client. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_api_clients_patch_with_http_info(api_clients, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• api_clients (ApiClientPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ApiClientResponse, status_code(int), headers(HTTPHeaderDict))

api236_api_clients_post_with_http_info(api_clients: ApiClientPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create an API client # noqa: E501

Creates an API client. Newly created API clients are disabled by default. Enable an API client through the PATCH method. The names, issuer, and public_key parameters are required. The access_policies or max_role parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_api_clients_post_with_http_info(api_clients, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• api_clients (ApiClientPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ApiClientResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.apps_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.apps_api.AppsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_apps_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List apps # noqa: E501

Displays a list of installed apps. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_apps_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AppGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_apps_nodes_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, app_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List app nodes # noqa: E501

Displays a list of installed apps and their nodes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_apps_nodes_get_with_http_info(authorization, x_request_id, app_names, continuation_token, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• app_names (List[str]) – The name of the installed app. Enter multiple names in comma-separated format.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AppNodeGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_apps_patch_with_http_info(names: ConstrainedListValue[StrictStr], app: App, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify app # noqa: E501

Modifies an installed app or modifies Virtual Network Computing (VNC) access for apps that are being patched. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_apps_patch_with_http_info(names, app, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• app (App) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AppResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.array_connections_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.array_connections_api.ArrayConnectionsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_array_connections_connection_key_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, encrypted: Optional[StrictBool] = None, **kwargs) → ApiResponse

List connection key # noqa: E501

Displays the connection key for the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_array_connections_connection_key_get_with_http_info(authorization, x_request_id, encrypted, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• encrypted (bool) – If true, the returned array connection key will encode an encryption key used to establish trust and secure replication traffic. If false, the returned array connection key will not encode an encryption key. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayConnectionKeyGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_array_connections_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete an array connection # noqa: E501

Deletes the connection between this array and the specified array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_array_connections_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_array_connections_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List the connected arrays # noqa: E501

Displays a list of connected arrays. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_array_connections_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayConnectionGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_array_connections_patch_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, refresh: Optional[StrictBool] = None, renew_encryption_key: Optional[StrictBool] = None, array_connection: Optional[ArrayConnectionPatch] = None, **kwargs) → ApiResponse

Modify an array connection # noqa: E501

Modifies attributes for an array connection. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_array_connections_patch_with_http_info(authorization, x_request_id, names, refresh, renew_encryption_key, array_connection, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• refresh (bool) – If set to true, the array will attempt to communicate with the connection peer in order to update the connection attributes on both arrays with any changes that have occurred. If set to true, other array connection attributes may not be modified in requests. Default value is false.

• renew_encryption_key (bool) – If set to true, update array connection with a new encryption key. If set to true, other array connection attributes may not be modified in requests. Defaults to false.

• array_connection (ArrayConnectionPatch) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayConnectionResponse, status_code(int), headers(HTTPHeaderDict))

api236_array_connections_path_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List connection path # noqa: E501

Displays the connection path from the array to which the connection was made. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_array_connections_path_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayConnectionPathGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_array_connections_post_with_http_info(array_connection: ArrayConnectionPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create an array connection # noqa: E501

Creates a connection between this array and the specified array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_array_connections_post_with_http_info(array_connection, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• array_connection (ArrayConnectionPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayConnectionResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.arrays_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.arrays_api.ArraysApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_arrays_cloud_capacity_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List CBS array capacity status # noqa: E501

Displays the capacity status of the CBS array including the progress of the capacity update. Requests for non-CBS arrays will receive an error response. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_cloud_capacity_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CloudCapacityGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_cloud_capacity_patch_with_http_info(capacity: CloudCapacityStatus, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify CBS array capacity # noqa: E501

Modifies the raw capacity of the CBS array. This should trigger a backend process that will update the CBS array capacity. The array capacity can be updated only to values defined by the capacity steps endpoint. When an existing capacity update request is in progress, any new request to update of the capacity will receive an error response. For non-CBS arrays, this feature is not supported and requests will receive an error response. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_cloud_capacity_patch_with_http_info(capacity, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• capacity (CloudCapacityStatus) – The requested capacity of the CBS array. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CloudCapacityPatchResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_cloud_capacity_supported_steps_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List CBS array capacity steps # noqa: E501

Displays the list of supported raw capacity sizes in bytes the CBS array can be upgraded to. Requests for non-CBS arrays will receive an error response. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_cloud_capacity_supported_steps_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CloudCapacityStepsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_cloud_provider_tags_batch_put_with_http_info(tag: ConstrainedListValue[CloudProviderTag], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Update user tags on the cloud. # noqa: E501

Updates users tags to deployed cloud resources of a CBS array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_cloud_provider_tags_batch_put_with_http_info(tag, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• tag (List[CloudProviderTag]) – A list of tags to be created or, if already existing, updated. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CloudProviderTagResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_cloud_provider_tags_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete user tags from the cloud. # noqa: E501

Deletes user tags from deployed cloud resources of a CBS array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_cloud_provider_tags_delete_with_http_info(authorization, x_request_id, keys, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• keys (List[str]) – A comma-separated list of tag keys.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_arrays_cloud_provider_tags_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List user tags on the cloud. # noqa: E501

Displays the list of user tags on deployed cloud resources of a CBS array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_cloud_provider_tags_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CloudProviderTagGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, eradicate_all_data: Optional[StrictBool] = None, factory_reset_token: Optional[StrictInt] = None, **kwargs) → ApiResponse

Delete an array # noqa: E501

Deletes an array. For physical appliances, deleting an array restores the hardware to factory settings. This entails deleting all data, metadata, configuration, and logs. The array returns to the state it was in prior to any configuration changes being made. If the hardware is reused, it must be as a different array with a new ID. For virtual appliances, deleting an array puts it into an unusable state. Virtual resources (e.g., virtual machines) can later be freed, which deletes any remaining data, metadata, configuration, and logs. Prior to factory reset, an array must be manually prepared (e.g., all volumes and snapshots must be eradicated) and a factory reset token must be created. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_delete_with_http_info(authorization, x_request_id, eradicate_all_data, factory_reset_token, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• eradicate_all_data (bool) – Set to true to perform a factory reset.

• factory_reset_token (int) – A token required to perform a factory reset.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_arrays_erasures_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Delete factory reset # noqa: E501

Deletes the factory reset process when it is failed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_erasures_delete_with_http_info(authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_arrays_erasures_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List factory reset details # noqa: E501

Displays a list of factory reset processes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_erasures_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayErasureGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_erasures_patch_with_http_info(delete_sanitization_certificate: StrictBool, eradicate_all_data: StrictBool, finalize: StrictBool, reinstall_image: StrictBool, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, erasure_patch: Optional[ArrayErasurePatch] = None, **kwargs) → ApiResponse

Update factory reset # noqa: E501

Modifies the factory reset process to finalize. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_erasures_patch_with_http_info(delete_sanitization_certificate, eradicate_all_data, finalize, reinstall_image, authorization, x_request_id, erasure_patch, async_req=True)
>>> result = thread.get()

Parameters

• delete_sanitization_certificate (bool) – Set to true to finalize factory reset and acknowledge the deletion of sanitization certificate. (required)

• eradicate_all_data (bool) – Set to true to perform a factory reset. (required)

• finalize (bool) – Must be true to finalize factory reset. (required)

• reinstall_image (bool) – Set to true to reinstall image, or false to skip reinstalling image. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• erasure_patch (ArrayErasurePatch) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayErasureResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_erasures_post_with_http_info(eradicate_all_data: StrictBool, preserve_configuration_data: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, skip_phonehome_check: Optional[StrictBool] = None, **kwargs) → ApiResponse

Create a process for factory reset # noqa: E501

Creates the initiation of the factory reset process # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_erasures_post_with_http_info(eradicate_all_data, preserve_configuration_data, authorization, x_request_id, skip_phonehome_check, async_req=True)
>>> result = thread.get()

Parameters

• eradicate_all_data (bool) – Set to true to perform a factory reset. (required)

• preserve_configuration_data (List[str]) – A comma-separated list of configuration data types to preserve. A value of all will preserve all configuration data types. Valid values include all. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• skip_phonehome_check (bool) – A flag to skip phonehome connectivity check. If skip_phonehome_check is not set, the factory reset will fail if phonehome connectivity check fails. Arrays that intentionally disable phonehome or do not permit connectivity to Pure Storage’s cloud servers must set this flag to true in order to start factory reset.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayErasureResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_eula_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List End User Agreement and signature # noqa: E501

Displays the End User Agreement and signature. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_eula_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(EulaGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_eula_patch_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, eula: Optional[Eula] = None, **kwargs) → ApiResponse

Modify signature on the End User Agreement # noqa: E501

Modifies the signature on the End User Agreement. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_eula_patch_with_http_info(authorization, x_request_id, eula, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• eula (Eula) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(EulaResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_factory_reset_token_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Delete a factory reset token # noqa: E501

Deletes an existing token that could be used to perform a factory reset on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_factory_reset_token_delete_with_http_info(authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_arrays_factory_reset_token_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List factory reset tokens # noqa: E501

Displays a list of tokens used to perform a factory reset on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_factory_reset_token_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayFactoryResetTokenGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_factory_reset_token_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create a factory reset token # noqa: E501

Creates a token that can be used to perform a factory reset on the array. Factory reset tokens can only be created after the array has been prepared for reset (e.g., all volumes and snapshots must first be eradicated). After a token has been created, operations that would take the array out of the prepared state are disabled (e.g., creating volumes) until all tokens have been deleted. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_factory_reset_token_post_with_http_info(authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayFactoryResetTokenResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List arrays # noqa: E501

Displays general array properties including the array name, login banner, idle timeout for management sessions, and NTP servers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_ntp_test_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

List NTP test results # noqa: E501

Displays test results for configured NTP servers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_ntp_test_get_with_http_info(authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_patch_with_http_info(array: Arrays, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify an array # noqa: E501

Modifies general array properties such as the array name, login banner, idle timeout for management sessions, and NTP servers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_patch_with_http_info(array, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• array (Arrays) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_performance_by_link_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List array front-end IO performance data by link # noqa: E501

Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth. Group output is shown by link. A link represents a set of arrays that an I/O operation depends on. For local-only I/Os, this is a local array. For mirrored I/Os, this is a set of synchronous replication peer arrays. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_performance_by_link_get_with_http_info(authorization, x_request_id, end_time, filter, limit, offset, resolution, sort, start_time, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayPerformanceByLinkGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_performance_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, protocol_group: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List array front-end performance data # noqa: E501

Displays real-time and historical front-end performance data at the array level including latency, bandwidth, IOPS, average I/O size, and queue depth. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_performance_get_with_http_info(authorization, x_request_id, end_time, filter, limit, offset, protocol, protocol_group, resolution, sort, start_time, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArrayPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_space_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List array space information # noqa: E501

Displays real-time and historical array space information including unique volume and snapshot space, shared space, data reduction, provisioned capacity, usable capacity, and parity. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_space_get_with_http_info(authorization, x_request_id, end_time, filter, limit, offset, resolution, sort, start_time, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ArraySpaceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_tags_batch_put_with_http_info(tag: ConstrainedListValue[NonCopyableTag], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Update tags # noqa: E501

Updates tags. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_tags_batch_put_with_http_info(tag, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• tag (List[NonCopyableTag]) – A list of tags to be created or, if already existing, updated. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TagResponse, status_code(int), headers(HTTPHeaderDict))

api236_arrays_tags_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete tags # noqa: E501

Deletes specified tags on array objects. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_tags_delete_with_http_info(authorization, x_request_id, keys, namespaces, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_arrays_tags_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List tags # noqa: E501

Displays the list of tags on array objects. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_arrays_tags_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, namespaces, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• namespaces (List[str]) – A comma-separated list of namespaces.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TagGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.audits_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.audits_api.AuditsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_audits_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List audits # noqa: E501

Displays a list of audits. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_audits_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(AuditGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.authorization_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.authorization_api.AuthorizationApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_login_post_with_http_info(api_token: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST login (placeholder) # noqa: E501

Exchange an API token for a session token. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_login_post_with_http_info(api_token, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• api_token (str) – API token for a user.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(UsernameResponse, status_code(int), headers(HTTPHeaderDict))

api236_logout_post_with_http_info(x_auth_token: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

POST logout (placeholder) # noqa: E501

Invalidate a session token. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_logout_post_with_http_info(x_auth_token, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• x_auth_token (str) – Session token for a user.

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api_api_version_get_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

List available API versions # noqa: E501

Returns a list of available API versions. No authentication is required to access this endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api_api_version_get_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ApiVersionResponse, status_code(int), headers(HTTPHeaderDict))

oauth210_token_post_with_http_info(grant_type: StrictStr, subject_token: StrictStr, subject_token_type: StrictStr, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Get access token # noqa: E501

Exchanges an ID Token for an OAuth 2.0 access token. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.oauth210_token_post_with_http_info(grant_type, subject_token, subject_token_type, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• grant_type (str) – The method by which the access token will be obtained. The Pure Storage REST API supports the OAuth 2.0 "token exchange" grant type, which indicates that a token exchange is being performed. Set grant_type to urn:ietf:params:oauth:grant-type:token-exchange. (required)

• subject_token (str) – An encoded security ID Token representing the identity of the party on behalf of whom the request is being made. The token must be issued by a trusted identity provider which must be either a registered application in Pure1 or an enabled API client on the array. The token must be a JSON Web Token and must contain the following claims: > | JWT claim | Location | API Client Field | Description | Required By | > |-|-|-|-|-| > | kid | Header | key_id | Key ID of the API client that issues the identity token. | FlashArray and FlashBlade only. | > | aud | Payload | id | Client ID of the API client that issues the identity token. | FlashArray and FlashBlade only. | > | sub | Payload | | Login name of the array user for whom the token should be issued. This must be a valid user in the system. | FlashArray and FlashBlade only. | > | iss | Payload | issuer | Application ID for the Pure1 or API client’s trusted identity issuer on the array. | All products. | > | iat | Payload | | Timestamp of when the identity token was issued. Measured in milliseconds since the UNIX epoch. | All products. | > | exp | Payload | | Timestamp of when the identity token will expire. Measured in milliseconds since the UNIX epoch. | All products. | Each token must also be signed with the private key that is paired with the API client’s public key. (required)

• subject_token_type (str) – An identifier that indicates the type of security token specifed in the subject_token parameter. The Pure Storage REST API supports the JSON Web Token (JWT) as the means for requesting the access token. Set subject_token_type to urn:ietf:params:oauth:token-type:jwt. (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(OauthTokenResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.certificate_groups_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.certificate_groups_api.CertificateGroupsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_certificate_groups_certificates_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete certificate-groups/certificates # noqa: E501

Deletes one or more certificate groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificate_groups_certificates_delete_with_http_info(authorization, x_request_id, certificate_group_ids, certificate_group_names, certificate_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (List[str]) – A comma-separated list of certificate group names. If no resource matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (List[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_certificate_groups_certificates_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List certificate-groups/certificates # noqa: E501

Displays membership associations between groups and certificates on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificate_groups_certificates_get_with_http_info(authorization, x_request_id, certificate_group_ids, certificate_group_names, certificate_names, continuation_token, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (List[str]) – A comma-separated list of certificate group names. If no resource matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (List[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateGroupCertificateGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_certificate_groups_certificates_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create certificate-groups/certificates # noqa: E501

Creates one or more certificates to one or more certificate groups on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificate_groups_certificates_post_with_http_info(authorization, x_request_id, certificate_group_ids, certificate_group_names, certificate_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (List[str]) – A comma-separated list of certificate group names. If no resource matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (List[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateGroupCertificateResponse, status_code(int), headers(HTTPHeaderDict))

api236_certificate_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete certificate-groups # noqa: E501

Deletes one or more certificate groups from the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificate_groups_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_certificate_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List certificate-groups # noqa: E501

Display all array certificate groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificate_groups_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateGroupGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_certificate_groups_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create certificate-groups # noqa: E501

Creates one or more certificate groups on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificate_groups_post_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateGroupResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.certificates_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.certificates_api.CertificatesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_certificates_certificate_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete certificates/certificate-groups # noqa: E501

Deletes one or more certificates from one or more certificate groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificates_certificate_groups_delete_with_http_info(authorization, x_request_id, certificate_group_ids, certificate_group_names, certificate_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (List[str]) – A comma-separated list of certificate group names. If no resource matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (List[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_certificates_certificate_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List certificates/certificate-groups # noqa: E501

Displays membership associations between groups and certificates. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificates_certificate_groups_get_with_http_info(authorization, x_request_id, certificate_group_ids, certificate_group_names, certificate_names, continuation_token, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (List[str]) – A comma-separated list of certificate group names. If no resource matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (List[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateCertificateGroupGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_certificates_certificate_groups_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, certificate_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, certificate_group_names: Optional[ConstrainedListValue[StrictStr]] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create certificates/certificate-groups # noqa: E501

Creates one or more certificates to one or more certificate groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificates_certificate_groups_post_with_http_info(authorization, x_request_id, certificate_group_ids, certificate_group_names, certificate_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_group_ids (List[str]) – A comma-separated list of certificate group ids. If there is not at least one resource that matches each of the elements of certificate_group_ids, then an error is returned. This cannot be provided in conjunction with the certificate_group_names parameter.

• certificate_group_names (List[str]) – A comma-separated list of certificate group names. If no resource matches each of the elements of certificate_group_names, then an error is returned. This cannot be provided in conjunction with the certificate_group_ids parameter.

• certificate_names (List[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateCertificateGroupResponse, status_code(int), headers(HTTPHeaderDict))

api236_certificates_certificate_signing_requests_post_with_http_info(certificate: CertificateSigningRequestPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create certificate signing request # noqa: E501

Creates a certificate signing request based on the certificate type and parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificates_certificate_signing_requests_post_with_http_info(certificate, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• certificate (CertificateSigningRequestPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateSigningRequestResponse, status_code(int), headers(HTTPHeaderDict))

api236_certificates_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete certificate # noqa: E501

Deletes a specific certificate object. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificates_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_certificates_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List certificate attributes # noqa: E501

Displays certificate attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificates_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_certificates_patch_with_http_info(certificate: CertificatePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, generate_new_key: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify certificates # noqa: E501

Modifies certificate attributes. When you modify the attributes of a self-signed certificate, Purity//FA replaces the existing certificate with a new certificate, which is generated with the specified attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificates_patch_with_http_info(certificate, authorization, x_request_id, generate_new_key, names, async_req=True)
>>> result = thread.get()

Parameters

• certificate (CertificatePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• generate_new_key (bool) – If set to true, a new private key is generated when generating a new certificate with the specified attributes. This may not be set to true when importing a certificate and private key, and may not be set to false when generating a new self-signed certificate to replace a certificate that was imported. Default setting is false.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateResponse, status_code(int), headers(HTTPHeaderDict))

api236_certificates_post_with_http_info(certificate: CertificatePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create certificate # noqa: E501

Creates a certificate object and specifies the valid time period and organization details of the certificate. A certificate can be imported or manually configured. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_certificates_post_with_http_info(certificate, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• certificate (CertificatePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(CertificateResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.connections_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.connections_api.ConnectionsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_connections_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, host_group_names: Optional[ConstrainedListValue[StrictStr]] = None, host_names: Optional[ConstrainedListValue[StrictStr]] = None, volume_ids: Optional[ConstrainedListValue[StrictStr]] = None, volume_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a connection between a volume and its host or host group # noqa: E501

Deletes the connection between a volume and its associated host or host group. One of volume_names or volume_ids and one of host_names or host_group_names query parameters are required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_connections_delete_with_http_info(authorization, x_request_id, host_group_names, host_names, volume_ids, volume_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• host_group_names (List[str]) – Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., host_group_names) must be set to only one name (e.g., hgroup01).

• host_names (List[str]) – Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, host01,host02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., host_names) must be set to only one name (e.g., host01).

• volume_ids (List[str]) – Performs the operation on the specified volume. Enter multiple ids in comma-separated format. For example, vol01id,vol02id. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., volume_ids) must be set to only one name (e.g., vol01id). Only one of the two between volume_names and volume_ids may be used at a time.

• volume_names (List[str]) – Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, vol01,vol02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., volume_names) must be set to only one name (e.g., vol01).

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_connections_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, host_group_names: Optional[ConstrainedListValue[StrictStr]] = None, host_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, protocol_endpoint_ids: Optional[ConstrainedListValue[StrictStr]] = None, protocol_endpoint_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, volume_ids: Optional[ConstrainedListValue[StrictStr]] = None, volume_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

List volume connections # noqa: E501

Displays a list of connections between a volume and its hosts and host groups, as well as the logical unit numbers (LUNs) or NVMe Namespace IDs (NSIDs) used by the associated hosts to address these volumes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_connections_get_with_http_info(authorization, x_request_id, continuation_token, filter, host_group_names, host_names, limit, offset, protocol_endpoint_ids, protocol_endpoint_names, sort, total_item_count, volume_ids, volume_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• host_group_names (List[str]) – Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., host_group_names) must be set to only one name (e.g., hgroup01).

• host_names (List[str]) – Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, host01,host02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., host_names) must be set to only one name (e.g., host01).

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol_endpoint_ids (List[str]) – Performs the operation on the protocol endpoints specified. Enter multiple IDs in comma-separated format. For example, peid01,peid02. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple protocol endpoint IDs and host names. Instead, at least one of the objects (e.g., protocol_endpoint_ids) must be set to one ID (e.g., peid01).

• protocol_endpoint_names (List[str]) – Performs the operation on the protocol endpoints specified. Enter multiple names in comma-separated format. For example, pe01,pe02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple protocol endpoint names and host names; instead, at least one of the objects (e.g., protocol_endpoint_names) must be set to one name (e.g., pe01).

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• volume_ids (List[str]) – Performs the operation on the specified volume. Enter multiple ids in comma-separated format. For example, vol01id,vol02id. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., volume_ids) must be set to only one name (e.g., vol01id). Only one of the two between volume_names and volume_ids may be used at a time.

• volume_names (List[str]) – Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, vol01,vol02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., volume_names) must be set to only one name (e.g., vol01).

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ConnectionGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_connections_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, host_group_names: Optional[ConstrainedListValue[StrictStr]] = None, host_names: Optional[ConstrainedListValue[StrictStr]] = None, volume_ids: Optional[ConstrainedListValue[StrictStr]] = None, volume_names: Optional[ConstrainedListValue[StrictStr]] = None, connection: Optional[ConnectionPost] = None, **kwargs) → ApiResponse

Create a connection between a volume and host or host group # noqa: E501

Creates a connection between a volume and a host or host group. One of volume_names or volume_ids and one of host_names or host_group_names query parameters are required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_connections_post_with_http_info(authorization, x_request_id, host_group_names, host_names, volume_ids, volume_names, connection, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• host_group_names (List[str]) – Performs the operation on the host group specified. Enter multiple names in comma-separated format. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host group names and volume names; instead, at least one of the objects (e.g., host_group_names) must be set to only one name (e.g., hgroup01).

• host_names (List[str]) – Performs the operation on the hosts specified. Enter multiple names in comma-separated format. For example, host01,host02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple host names and volume names; instead, at least one of the objects (e.g., host_names) must be set to only one name (e.g., host01).

• volume_ids (List[str]) – Performs the operation on the specified volume. Enter multiple ids in comma-separated format. For example, vol01id,vol02id. A request cannot include a mix of multiple objects with multiple IDs. For example, a request cannot include a mix of multiple volume IDs and host names; instead, at least one of the objects (e.g., volume_ids) must be set to only one name (e.g., vol01id). Only one of the two between volume_names and volume_ids may be used at a time.

• volume_names (List[str]) – Performs the operation on the volume specified. Enter multiple names in comma-separated format. For example, vol01,vol02. A request cannot include a mix of multiple objects with multiple names. For example, a request cannot include a mix of multiple volume names and host names; instead, at least one of the objects (e.g., volume_names) must be set to only one name (e.g., vol01).

• connection (ConnectionPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ConnectionResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.container_default_protections_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.container_default_protections_api.ContainerDefaultProtectionsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_container_default_protections_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List container default protections # noqa: E501

Displays a list of containers with its default protections. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_container_default_protections_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the container ID specified. Enter multiple source IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together. Specifying ids or names with no value will perform the operation on local array.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique container name specified. Enter multiple names in comma-separated format. The ids or names parameter is required, but they cannot be set together. Specifying ids or names with no value will perform the operation on local array.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ContainerDefaultProtectionGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_container_default_protections_patch_with_http_info(container_default_protection: ContainerDefaultProtection, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a container’s default protections # noqa: E501

Modifies a container’s default protections. To modify, set default_protections to the new list. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_container_default_protections_patch_with_http_info(container_default_protection, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• container_default_protection (ContainerDefaultProtection) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the container ID specified. Enter multiple source IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together. Specifying ids or names with no value will perform the operation on local array.

• names (List[str]) – Performs the operation on the unique container name specified. Enter multiple names in comma-separated format. The ids or names parameter is required, but they cannot be set together. Specifying ids or names with no value will perform the operation on local array.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ContainerDefaultProtectionResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.controllers_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.controllers_api.ControllersApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_controllers_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List controller information and status # noqa: E501

Displays the name, mode, FlashArray model, Purity//FA software version, and status of each controller in the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_controllers_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ControllerGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.directories_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.directories_api.DirectoriesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_directories_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete managed directories # noqa: E501

Deletes one or more managed directories. To be deleted, a managed directory must be empty and not attached to any enabled export policies. Deleted managed directories cannot be recovered. The ids or names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directories_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List directories # noqa: E501

Displays a list of directories, including those pending eradication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, file_system_ids, file_system_names, filter, ids, limit, names, offset, sort, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• file_system_ids (List[str]) – Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The file_system_ids or file_system_names parameter is required, but they cannot be set together.

• file_system_names (List[str]) – Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, filesystem01,filesystem02.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_locks_nlm_reclamations_post_with_http_info(x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Initiate NLM reclamation. # noqa: E501

NLM reclamation is a system-wide operation, affecting all clients, and so only one may be in progress at a time. Attempting to initiate reclamation while one is in progress will result in an error. When NLM reclamation is initiated, all NLM locks are deleted and client applications are notified that they can reacquire their locks within a grace period. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_locks_nlm_reclamations_post_with_http_info(x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryLockNlmReclamationResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_patch_with_http_info(directory: DirectoryPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a managed directory # noqa: E501

Modifies a managed directory. To rename a managed directory, set name to the new name. The ids or names parameter is required, but cannot be set together. The name or directory_name parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_patch_with_http_info(directory, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• directory (DirectoryPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_performance_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, protocol_group: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List directory performance data # noqa: E501

Displays real-time and historical performance data, real-time latency data, and average I/O sizes for each directory and as a total of all directories across the entire array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_performance_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, protocol, protocol_group, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_audit_file_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a membership between a directory and one or more audit policies # noqa: E501

Deletes a membership between a directory and one or more audit policies. Either the policy_ids or policy_names parameter is required, but they cannot be set together. Either the member_ids or member_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_audit_file_delete_with_http_info(authorization, x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directories_policies_audit_file_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List audit policies attached to a directory # noqa: E501

Displays a list of audit policies that are attached to directories. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_audit_file_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_audit_file_post_with_http_info(policies: DirectoryPolicyPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between a directory and one or more audit policies # noqa: E501

Creates a membership between a directory and one or more audit policies. Either the member_ids or member_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_audit_file_post_with_http_info(policies, authorization, x_request_id, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• policies (DirectoryPolicyPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_autodir_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a membership between a directory and one or more auto managed directory policies # noqa: E501

Deletes a membership between a directory with one or more auto managed directory policies. The policy_ids or policy_names parameter is required, but they cannot be set together. The member_ids or member_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_autodir_delete_with_http_info(authorization, x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directories_policies_autodir_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List auto managed directory policies attached to a directory # noqa: E501

Displays a list of auto managed directory policies that are attached to directories. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_autodir_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_autodir_post_with_http_info(policies: DirectoryPolicyPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between a directory with one or more auto managed directory policies # noqa: E501

Creates a membership between a directory with one or more auto managed directory policies. The member_ids or member_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_autodir_post_with_http_info(policies, authorization, x_request_id, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• policies (DirectoryPolicyPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List policies # noqa: E501

Displays a list of policies that are attached to directories. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_nfs_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a membership between a directory and one or more NFS policies # noqa: E501

Deletes a membership between a directory and one or more NFS policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_nfs_delete_with_http_info(authorization, x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directories_policies_nfs_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List NFS policies attached to a directory # noqa: E501

Displays a list of NFS policies that are attached to directories. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_nfs_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberExportGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_nfs_post_with_http_info(policies: DirectoryPolicyExportPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between a directory and one or more NFS policies # noqa: E501

Creates a membership between a directory and one or more NFS policies. The member_ids or member_names parameter is required but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_nfs_post_with_http_info(policies, authorization, x_request_id, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• policies (DirectoryPolicyExportPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberExportResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_quota_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a membership between a directory and one or more quota policies # noqa: E501

Deletes a membership between a directory and one or more quota policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_quota_delete_with_http_info(authorization, x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directories_policies_quota_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List quota policies attached to a directory # noqa: E501

Displays a list of quota policies that are attached to directories. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_quota_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_quota_post_with_http_info(policies: DirectoryPolicyPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ignore_usage: Optional[StrictBool] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between a directory and one or more quota policies # noqa: E501

Creates a membership between a directory and one or more quota policies. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_quota_post_with_http_info(policies, authorization, x_request_id, ignore_usage, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• policies (DirectoryPolicyPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ignore_usage (bool) – Flag used to override checks for quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_smb_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a membership between a directory and one or more SMB policies # noqa: E501

Deletes a membership between a directory and one or more SMB policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_smb_delete_with_http_info(authorization, x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directories_policies_smb_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SMB policies attached to a directory # noqa: E501

Displays a list of SMB policies that are attached to directories. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_smb_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberExportGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_smb_post_with_http_info(policies: DirectoryPolicyExportPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between a directory and one or more SMB policies # noqa: E501

Creates a membership between a directory and one or more SMB policies. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_smb_post_with_http_info(policies, authorization, x_request_id, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• policies (DirectoryPolicyExportPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberExportResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_snapshot_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a membership between a directory and one or more snapshot policies # noqa: E501

Deletes a membership between a directory and one or more snapshot policies. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_snapshot_delete_with_http_info(authorization, x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directories_policies_snapshot_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List snapshot policies attached to a directory # noqa: E501

Displays a list of snapshot policies that are attached to directories. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_snapshot_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_policies_snapshot_post_with_http_info(policies: DirectoryPolicyPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between a directory with one or more snapshot policies # noqa: E501

Creates a membership between a directory with one or more snapshot policies. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_policies_snapshot_post_with_http_info(policies, authorization, x_request_id, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• policies (DirectoryPolicyPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_post_with_http_info(directory: DirectoryPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, file_system_ids: Optional[ConstrainedListValue[StrictStr]] = None, file_system_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create directory # noqa: E501

Creates a managed directory at the specified path. The managed directory name must consist of a file system name prefix and a managed directory name suffix (separated with ‘&#58;’). The suffix must be between 1 and 63 characters (alphanumeric and ‘-’) in length and begin and end with a letter or number. The suffix must include at least one letter or ‘-’. Set names to create a managed directory with the specified full managed directory name, or set file_system_names or file_system_ids in the query parameters and suffix in the body parameters to create a managed directory in the specified file system with the specified suffix. These two options are exclusive. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_post_with_http_info(directory, authorization, x_request_id, file_system_ids, file_system_names, names, async_req=True)
>>> result = thread.get()

Parameters

• directory (DirectoryPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• file_system_ids (List[str]) – Performs the operation on the file system ID specified. Enter multiple file system IDs in comma-separated format. The file_system_ids or file_system_names parameter is required, but they cannot be set together.

• file_system_names (List[str]) – Performs the operation on the file system name specified. Enter multiple file system names in comma-separated format. For example, filesystem01,filesystem02.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryResponse, status_code(int), headers(HTTPHeaderDict))

api236_directories_space_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List directory space information # noqa: E501

Displays physical storage consumption data for each directory. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directories_space_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourceDirectorySpaceGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.directory_exports_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.directory_exports_api.DirectoryExportsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_directory_exports_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, export_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete directory exports # noqa: E501

Deletes one or more directory exports. If any of the export_names is not unique across the system, policy_ids or policy_names must be specified to determine the exports. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_exports_delete_with_http_info(authorization, x_request_id, directory_ids, directory_names, export_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• directory_ids (List[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (List[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• export_names (List[str]) – Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directory_exports_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, export_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List directory exports # noqa: E501

Displays a list of directory exports. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_exports_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, directory_ids, directory_names, export_names, filter, limit, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• directory_ids (List[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (List[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• export_names (List[str]) – Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, name01,name02.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryExportGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_exports_patch_with_http_info(export: DirectoryExportPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, export_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify directory exports # noqa: E501

Modifies a directory export. Used for manually renaming, enabling, and disabling directory exports. To rename a directory export, set ‘export_name’ to the new name. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_exports_patch_with_http_info(export, authorization, x_request_id, directory_ids, directory_names, export_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• export (DirectoryExportPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• directory_ids (List[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (List[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• export_names (List[str]) – Performs the operation on the export names specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryExportResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_exports_post_with_http_info(exports: DirectoryExportPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create directory exports # noqa: E501

Creates an export of a managed directory. The directory_ids or directory_names parameter is required, but cannot be set together. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_exports_post_with_http_info(exports, authorization, x_request_id, directory_ids, directory_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• exports (DirectoryExportPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• directory_ids (List[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (List[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryExportResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.directory_quotas_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.directory_quotas_api.DirectoryQuotasApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_directory_quotas_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List directories with attached quota policies # noqa: E501

Displays a list of directories and the quota policies attached to them. Directories with multiple policies are listed repeatedly (once per policy). The directories without a policy attached are not listed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_quotas_get_with_http_info(authorization, x_request_id, continuation_token, directory_ids, directory_names, filter, limit, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• directory_ids (List[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (List[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryQuotasGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.directory_services_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.directory_services_api.DirectoryServicesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_directory_services_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List directory services configuration # noqa: E501

Displays the directory services configuration settings for manageability. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryServiceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_local_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sids: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete local groups # noqa: E501

Deletes one or more local groups. The gids, names, or sids parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_groups_delete_with_http_info(authorization, x_request_id, gids, names, sids, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• sids (List[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directory_services_local_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sids: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List local groups # noqa: E501

Displays a list of local groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_groups_get_with_http_info(authorization, x_request_id, continuation_token, filter, gids, ids, limit, names, offset, sids, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sids (List[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LocalGroupGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_local_groups_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictInt]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_sids: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete local group membership # noqa: E501

Deletes one or more local group memberships. The group_names, group_sids, or group_ids parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_groups_members_delete_with_http_info(authorization, x_request_id, group_gids, group_names, group_sids, member_ids, member_names, member_sids, member_types, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• group_names (List[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (List[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_ids (List[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (List[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directory_services_local_groups_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictInt]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_sids: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List local group memberships # noqa: E501

Displays a list of local group memberships. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_groups_members_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_gids, group_names, group_sids, limit, member_ids, member_names, member_sids, member_types, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• group_names (List[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (List[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (List[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LocalMembershipGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_local_groups_members_post_with_http_info(local_membership: LocalGroupMembershipPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create local group membership # noqa: E501

Creates a local group membership with a group. The group_names, group_sids, or group_ids parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_groups_members_post_with_http_info(local_membership, authorization, x_request_id, group_gids, group_names, group_sids, async_req=True)
>>> result = thread.get()

Parameters

• local_membership (LocalGroupMembershipPost) – The member_names, member_sids, or member_gids parameter is required, but cannot be set together. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• group_names (List[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (List[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LocalMembershipResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_local_groups_patch_with_http_info(local_group: LocalGroup, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, gids: Optional[ConstrainedListValue[StrictInt]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sids: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify local groups # noqa: E501

Modifies local groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_groups_patch_with_http_info(local_group, authorization, x_request_id, gids, names, sids, async_req=True)
>>> result = thread.get()

Parameters

• local_group (LocalGroup) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• sids (List[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LocalGroupResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_local_groups_post_with_http_info(names: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, local_group: Optional[LocalGroupPost] = None, **kwargs) → ApiResponse

Create local group # noqa: E501

Creates a local group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_groups_post_with_http_info(names, authorization, x_request_id, local_group, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• local_group (LocalGroupPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LocalGroupResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_local_users_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sids: Optional[ConstrainedListValue[StrictStr]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, **kwargs) → ApiResponse

Delete local users # noqa: E501

Deletes one or more local users. The uids, names, or sids parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_users_delete_with_http_info(authorization, x_request_id, names, sids, uids, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• sids (List[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• uids (List[int]) – A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, 423,51234.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directory_services_local_users_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sids: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, **kwargs) → ApiResponse

List local users # noqa: E501

Displays a list of local users. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_users_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, sids, sort, total_item_count, uids, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sids (List[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• uids (List[int]) – A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, 423,51234.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LocalUserGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_local_users_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictInt]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_sids: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete local user membership # noqa: E501

Deletes one or more local user memberships. The member_names, member_sids, or member_ids parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_users_members_delete_with_http_info(authorization, x_request_id, group_gids, group_names, group_sids, member_ids, member_names, member_sids, member_types, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• group_names (List[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (List[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_ids (List[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (List[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directory_services_local_users_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_gids: Optional[ConstrainedListValue[StrictInt]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, group_sids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictInt]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_sids: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List local user memberships # noqa: E501

Displays a list of local user memberships. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_users_members_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_gids, group_names, group_sids, limit, member_ids, member_names, member_sids, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_gids (List[int]) – Performs the operation on the specified GIDs. Enter multiple GIDs in comma-separated format. For example, 4234235,9681923.

• group_names (List[str]) – Performs the operation on the group names specified. Enter multiple group names in comma-separated format. For example, group1,group2.

• group_sids (List[str]) – Performs the operation on the specified group SID. Enter multiple group SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (List[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LocalMembershipGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_local_users_members_post_with_http_info(local_membership: LocalUserMembershipPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictInt]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_sids: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create local user membership # noqa: E501

Creates a local user membership with a group. The member_names or member_sids or member_ids parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_users_members_post_with_http_info(local_membership, authorization, x_request_id, member_ids, member_names, member_sids, async_req=True)
>>> result = thread.get()

Parameters

• local_membership (LocalUserMembershipPost) – The group_names, group_sids, or group_gids parameter is required, but cannot be set together. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[int]) – Performs the operation on the unique local member IDs specified. Enter multiple member IDs in comma-separated format. For local group IDs refer to group IDs (GID). For local user IDs refer to user IDs (UID). The member_ids and member_names parameters cannot be provided together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_sids (List[str]) – Performs the operation on the specified member SID. Enter multiple member SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LocalMembershipResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_local_users_patch_with_http_info(local_user: LocalUserPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, keep_open_sessions: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, sids: Optional[ConstrainedListValue[StrictStr]] = None, uids: Optional[ConstrainedListValue[StrictInt]] = None, **kwargs) → ApiResponse

Modify local user # noqa: E501

Modifies a local user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_users_patch_with_http_info(local_user, authorization, x_request_id, keep_open_sessions, names, sids, uids, async_req=True)
>>> result = thread.get()

Parameters

• local_user (LocalUserPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• keep_open_sessions (bool) – If set to true, the session does not expire. If set to false, when the user is disabled or password is changed, the session expires. If not specified, defaults to false.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• sids (List[str]) – Performs the operation on the object SID specified. Enter multiple SIDs in comma-separated format. For example, S-1-2-532-582374278-329482934,S-1-2-532-234235245-423425234.

• uids (List[int]) – A comma-separated list of local user IDs (UIDs). Enter multiple local user IDs in comma-separated format. For example, 423,51234.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LocalUserResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_local_users_post_with_http_info(names: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, local_user: Optional[LocalUserPost] = None, **kwargs) → ApiResponse

Create local user # noqa: E501

Creates a local user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_local_users_post_with_http_info(names, authorization, x_request_id, local_user, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• local_user (LocalUserPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LocalUserResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_patch_with_http_info(names: ConstrainedListValue[StrictStr], directory_service: DirectoryService, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify directory services configuration # noqa: E501

Modifies the directory service configuration. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_patch_with_http_info(names, directory_service, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• directory_service (DirectoryService) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryServiceResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_roles_delete_with_http_info(names: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Delete group to management access policy mappings # noqa: E501

Deletes one or more group to management access policy mappings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_roles_delete_with_http_info(names, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directory_services_roles_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List group to management access policy mappings # noqa: E501

Displays access control settings for remote groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_roles_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, role_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• role_names (List[str]) – This field has been deprecated.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryServiceRoleGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_roles_patch_with_http_info(names: ConstrainedListValue[StrictStr], directory_service_roles: DirectoryServiceRole, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, role_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify group to management access policy mappings # noqa: E501

Modifies properties of one or more group to management access policy mappings. Modifying management access policies is done at /directory-services/roles/policies/management-access instead. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_roles_patch_with_http_info(names, directory_service_roles, authorization, x_request_id, role_names, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format. (required)

• directory_service_roles (DirectoryServiceRole) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• role_names (List[str]) – This field has been deprecated.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryServiceRoleResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_roles_policies_management_access_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a membership between a group to management access policy mapping and one or more management access policies # noqa: E501

Deletes a membership between a group to management access policy mapping with one or more management access policies. The policy_ids or policy_names is required, but they cannot be set together. Also, member_ids or member_names is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_roles_policies_management_access_delete_with_http_info(authorization, x_request_id, member_ids, member_names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directory_services_roles_policies_management_access_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List management access policies attached to a group to management access policy mapping # noqa: E501

Displays a list of management access policies that are attached to group to management access policy mappings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_roles_policies_management_access_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, member_ids, member_names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberCleanGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_roles_policies_management_access_post_with_http_info(policies: PolicyAssignmentPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between a group to management access policy mapping with one or more management access policies # noqa: E501

Creates a membership between a group to management access policy mapping with one or more management access policies. The member_ids or member_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_roles_policies_management_access_post_with_http_info(policies, authorization, x_request_id, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• policies (PolicyAssignmentPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberCleanResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_roles_post_with_http_info(names: ConstrainedListValue[StrictStr], directory_service_roles: DirectoryServiceRolePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create a group in management access policy mappings # noqa: E501

Creates one or more groups in management access policy mappings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_roles_post_with_http_info(names, directory_service_roles, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique names specified. For example, GroupRoleMappingName. Enter multiple names in comma-separated format. (required)

• directory_service_roles (DirectoryServiceRolePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectoryServiceRoleResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_services_test_get_with_http_info(names: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List directory services test results # noqa: E501

Displays the directory services test and displays the results. The test verifies that URIs can be resolved and that the array can bind and query the tree using the bind user credentials. The test also verifies that the array can find all configured groups to ensure the common names and group base are correctly configured. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_services_test_get_with_http_info(names, authorization, x_request_id, continuation_token, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.directory_snapshots_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.directory_snapshots_api.DirectorySnapshotsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_directory_snapshots_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete directory snapshot # noqa: E501

Deletes a directory snapshot that has been destroyed and is pending eradication. Eradicated directory snapshots cannot be recovered. Directory snapshots are destroyed by using the PATCH method. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_snapshots_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_directory_snapshots_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List directory snapshots # noqa: E501

Displays a list of directory snapshots, including those pending eradication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_snapshots_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, source_ids, source_names, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectorySnapshotGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_snapshots_patch_with_http_info(directory_snapshot: DirectorySnapshotPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify directory snapshot # noqa: E501

Modifies a directory snapshot. You can destroy, recover, or update the policy or time remaining of a directory snapshot. To destroy a directory snapshot, set destroyed=true. To recover a directory snapshot that has been destroyed and is pending eradication, set destroyed=false. To rename a directory snapshot, set name to the new name. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_snapshots_patch_with_http_info(directory_snapshot, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• directory_snapshot (DirectorySnapshotPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectorySnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api236_directory_snapshots_post_with_http_info(directory_snapshot: DirectorySnapshotPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create directory snapshot # noqa: E501

Creates a snapshot of the contents of a directory. The source_ids or source_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_directory_snapshots_post_with_http_info(directory_snapshot, authorization, x_request_id, source_ids, source_names, async_req=True)
>>> result = thread.get()

Parameters

• directory_snapshot (DirectorySnapshotPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DirectorySnapshotResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.dns_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.dns_api.DNSApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_dns_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete DNS configuration # noqa: E501

Deletes DNS configuration identified by configuration name. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_dns_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_dns_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List DNS parameters # noqa: E501

Displays the current DNS configurations and their parameters including domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_dns_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DnsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_dns_patch_with_http_info(dns: DnsPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify DNS parameters # noqa: E501

Modifies the DNS parameters of an array, including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. If there is no DNS configuration beforehand new DNS configuration with ‘default’ name is created. If more than one DNS configuration exists name has to be specified to identify the DNS configuration to be modified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_dns_patch_with_http_info(dns, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• dns (DnsPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DnsResponse, status_code(int), headers(HTTPHeaderDict))

api236_dns_post_with_http_info(dns: DnsPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create DNS configuration # noqa: E501

Creates new DNS configuration with parameters including the domain suffix, the list of DNS name server IP addresses, and the list of services that DNS parameters apply to. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_dns_post_with_http_info(dns, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• dns (DnsPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DnsResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.drives_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.drives_api.DrivesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_drives_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List flash, NVRAM, and cache modules # noqa: E501

Displays a list of flash, NVRAM, and cache modules that are installed in the array along with their attributes and status. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_drives_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DriveGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_drives_patch_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, admit: Optional[StrictBool] = None, **kwargs) → ApiResponse

Modify flash and NVRAM modules # noqa: E501

Modifies flash and NVRAM modules that have been added or connected but not yet admitted to the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_drives_patch_with_http_info(authorization, x_request_id, admit, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• admit (bool) – If true, admits any unadmitted drives into the system.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(DriveResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.file_systems_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.file_systems_api.FileSystemsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_file_systems_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete file system # noqa: E501

Deletes a file system that has been destroyed and is pending eradication. Eradicated file systems cannot be recovered. File systems are destroyed using the PATCH method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_file_systems_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_file_systems_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List file systems # noqa: E501

Displays a list of file systems, including those pending eradication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_file_systems_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_file_systems_patch_with_http_info(file_system: FileSystemPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a file system # noqa: E501

Modifies a file system. You can rename, destroy, move, or recover a file system. To rename a file system, set name to the new name. To destroy a file system, set destroyed=true. To move a file system, set ‘pod’ to the destination pod reference. To recover a file system that has been destroyed and is pending eradication, set destroyed=false. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_file_systems_patch_with_http_info(file_system, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• file_system (FileSystemPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemResponse, status_code(int), headers(HTTPHeaderDict))

api236_file_systems_post_with_http_info(names: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create file system # noqa: E501

Creates one or more file systems. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_file_systems_post_with_http_info(names, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FileSystemResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.files_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.files_api.FilesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_files_post_with_http_info(source_file: FilePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, directory_ids: Optional[ConstrainedListValue[StrictStr]] = None, directory_names: Optional[ConstrainedListValue[StrictStr]] = None, overwrite: Optional[StrictBool] = None, paths: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a file copy # noqa: E501

Creates a file copy from one path to another path. The directory_ids, directory_names or paths value must be specified. If the directory_ids or directory_names value is not specified, the file is copied to the source directory specified in the body params. The paths value refers to the path of the target file relative to the target directory. If paths value is not specified, the file will be copied to the relative path specified in source_path under the target directory. The source_path value refers to the path of the source file relative to the source directory. To overwrite an existing file, set the overwrite flag to true. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_files_post_with_http_info(source_file, authorization, x_request_id, directory_ids, directory_names, overwrite, paths, async_req=True)
>>> result = thread.get()

Parameters

• source_file (FilePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• directory_ids (List[str]) – Performs the operation on the unique managed directory IDs specified. Enter multiple managed directory IDs in comma-separated format. The directory_ids or directory_names parameter is required, but they cannot be set together.

• directory_names (List[str]) – Performs the operation on the managed directory names specified. Enter multiple full managed directory names in comma-separated format. For example, fs:dir01,fs:dir02.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• paths (List[str]) – Target file path relative to the target directory. Enter multiple target file path in a comma-separated format. For example, /dir1/dir2/file1,/dir3/dir4/file2.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

pypureclient.flasharray.FA_2_36.api.fleets_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.fleets_api.FleetsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_fleets_fleet_key_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

Get fleet key information # noqa: E501

Displays the time remaining on the fleet key. Note, fleet key itself is not displayed, since that is only available at time of fleet key creation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_fleets_fleet_key_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetKeyGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_fleets_fleet_key_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create a fleet key # noqa: E501

Creates a fleet key allowing an array to be added to a fleet. This is the only time the fleet key is displayed, it cannot be retrieved subsequently. Note, creation of a subsequent key invalidates all keys created earlier. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_fleets_fleet_key_post_with_http_info(authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetKeyResponse, status_code(int), headers(HTTPHeaderDict))

api236_fleets_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List fleets # noqa: E501

Displays information about the fleets known to the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_fleets_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique resource names specified. Only one value is supported.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_fleets_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, unreachable: Optional[StrictBool] = None, **kwargs) → ApiResponse

Delete fleet members # noqa: E501

Deletes the specified array(s) from the fleet. Note that this will only succeed if the array(s) to be removed are not making use of any fleet resources. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_fleets_members_delete_with_http_info(authorization, x_request_id, member_ids, member_names, unreachable, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• unreachable (bool) – If set to true, allows a one-sided disconnect when the connection status is connecting instead of connected or partially connected. If set to false, it works just like normal coordinated disconnect. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_fleets_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List fleet members # noqa: E501

Displays the members in the current fleet. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_fleets_members_get_with_http_info(authorization, x_request_id, continuation_token, filter, fleet_ids, fleet_names, limit, member_ids, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• fleet_ids (List[str]) – Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID.

• fleet_names (List[str]) – Performs the operation on the unique Fleet names specified. Enter multiple names in comma-separated format. For example, name01,name02. This query currently accepts only 1 name.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_fleets_members_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, fleet_ids: Optional[ConstrainedListValue[StrictStr]] = None, fleet_names: Optional[ConstrainedListValue[StrictStr]] = None, members: Optional[FleetMemberPost] = None, **kwargs) → ApiResponse

Add members to a fleet # noqa: E501

Adds arrays to an existing fleet. This API needs to be run from the array that’s joining the fleet. To add the current array to the fleet, specify its own array id or name, as well as the fleet key generated on any array already in the fleet. resource_type is remote-arrays. The array’s ID and name can be retrieved with a call to GET /arrays on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_fleets_members_post_with_http_info(authorization, x_request_id, fleet_ids, fleet_names, members, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• fleet_ids (List[str]) – Performs the operation on the unique Fleet IDs specified. This query currently accepts only 1 ID.

• fleet_names (List[str]) – Performs the operation on the unique Fleet names specified. Enter multiple names in comma-separated format. For example, name01,name02. This query currently accepts only 1 name.

• members (FleetMemberPost) – Info about the members being added to fleet.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_fleets_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a fleet # noqa: E501

Creates a fleet and adds the current array as its first member. Additional arrays can be added to the fleet with POST /fleets/members # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_fleets_post_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique resource names specified. Only one value is supported.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(FleetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.hardware_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.hardware_api.HardwareApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_hardware_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List hardware component information # noqa: E501

Displays a list of hardware slots and bays and status of installed components. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hardware_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HardwareGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_hardware_patch_with_http_info(hardware: HardwarePatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify visual identification # noqa: E501

Modifies the visual identification of a specified hardware component, and causing the ID LED to turn on or off. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hardware_patch_with_http_info(hardware, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• hardware (HardwarePatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HardwareResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.host_groups_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.host_groups_api.HostGroupsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_host_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a host group # noqa: E501

Deletes a host group. The names query parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_host_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List host groups # noqa: E501

Displays a list of host groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HostGroupGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_host_groups_hosts_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Remove a host from a host group # noqa: E501

Removes a host from a host group. Removing a host from a host group automatically disconnects the host from all volumes associated with the group. Hosts can be removed from host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_hosts_delete_with_http_info(authorization, x_request_id, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_host_groups_hosts_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List host groups that are associated with hosts # noqa: E501

Returns a list of host groups that are associated with hosts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_hosts_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_names, limit, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdAllGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_host_groups_hosts_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Add a host to a host group # noqa: E501

Adds a host to a host group. Adding a host to a host group automatically connects the host to all volumes associated with the group. Multiple hosts can be belong to a host group, but a host can only belong to one host group. Hosts can be added to host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_hosts_post_with_http_info(authorization, x_request_id, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdAllResponse, status_code(int), headers(HTTPHeaderDict))

api236_host_groups_patch_with_http_info(host_group: HostGroupPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a host group # noqa: E501

Modifies a host group. The names query parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_patch_with_http_info(host_group, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• host_group (HostGroupPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HostGroupResponse, status_code(int), headers(HTTPHeaderDict))

api236_host_groups_performance_by_array_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List host group performance data by array # noqa: E501

Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed by total size across all host groups on each array and by individual host group on each array. The displayed data represents the volumes that are connected to a host group on the current array and the volumes that are connected to a host group on any remote arrays that are visible to the current array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_performance_by_array_get_with_http_info(authorization, x_request_id, end_time, filter, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourcePerformanceNoIdByArrayGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_host_groups_performance_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List host group performance data # noqa: E501

Displays real-time and historical performance data, real-time latency data, and average I/O sizes of all host groups, displayed both by host group and by total size across all host groups. This data represents volumes that are connected to the host groups on the local array and stretched volumes connected to the host groups on arrays that are connected by synchronous replication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_performance_get_with_http_info(authorization, x_request_id, end_time, filter, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourcePerformanceNoIdGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_host_groups_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a host group # noqa: E501

Creates a host group. The names query parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_post_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HostGroupResponse, status_code(int), headers(HTTPHeaderDict))

api236_host_groups_protection_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a host group from a protection group # noqa: E501

Deletes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed are not affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_protection_groups_delete_with_http_info(authorization, x_request_id, group_ids, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_host_groups_protection_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List host groups that are members of protection groups # noqa: E501

Displays a list of host group members that belong to one or more protection groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_protection_groups_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_ids, group_names, limit, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_host_groups_protection_groups_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a host group # noqa: E501

Creates a host group member and assigns to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_protection_groups_post_with_http_info(authorization, x_request_id, group_ids, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_host_groups_space_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List host group space information # noqa: E501

Displays provisioned size and physical storage consumption data for each host group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_space_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourceSpaceNoIdGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_host_groups_tags_batch_put_with_http_info(tag: ConstrainedListValue[NonCopyableTag], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Update tags # noqa: E501

Updates tags. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_tags_batch_put_with_http_info(tag, authorization, x_request_id, resource_ids, resource_names, async_req=True)
>>> result = thread.get()

Parameters

• tag (List[NonCopyableTag]) – A list of tags to be created or, if already existing, updated. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TagResponse, status_code(int), headers(HTTPHeaderDict))

api236_host_groups_tags_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete tags # noqa: E501

Deletes specified tags on host group objects. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_tags_delete_with_http_info(authorization, x_request_id, keys, namespaces, resource_ids, resource_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_host_groups_tags_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List tags # noqa: E501

Displays the list of tags on host group objects. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_host_groups_tags_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, namespaces, offset, resource_ids, resource_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• namespaces (List[str]) – A comma-separated list of namespaces.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TagGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.hosts_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.hosts_api.HostsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_hosts_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a host # noqa: E501

Deletes an existing host. All volumes that are connected to the host, either through private or shared connections, must be disconnected from the host before the host can be deleted. The names query parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_hosts_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List hosts # noqa: E501

Displays a list of hosts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HostGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_host_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Remove a host from a host group # noqa: E501

Removes a host from a host group. Removing a host from a host group automatically disconnects the host from all volumes associated with the group. Hosts can be removed from host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_host_groups_delete_with_http_info(authorization, x_request_id, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_hosts_host_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List hosts that are associated with host groups # noqa: E501

Returns a list of hosts that are associated with host groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_host_groups_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_names, limit, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdAllGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_host_groups_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Add a host to a host group # noqa: E501

Adds a host to a host group. Adding a host to a host group automatically connects the host to all volumes associated with the group. Multiple hosts can be belong to a host group, but a host can only belong to one host group. Hosts can be added to host groups at any time. The group_names and member_names parameters are required and must be set together, and only one host group can be specified at a time. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_host_groups_post_with_http_info(authorization, x_request_id, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdAllResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_patch_with_http_info(host: HostPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a host # noqa: E501

Modifies an existing host, including its storage network addresses, CHAP, host personality, and preferred arrays, or associate a host to a host group. The names query parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_patch_with_http_info(host, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• host (HostPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HostResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_performance_balance_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List host performance balance # noqa: E501

Displays the I/O balance statistics for host paths. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_performance_balance_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HostPerformanceBalanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_performance_by_array_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List host performance data by array # noqa: E501

Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed by total size across all hosts on each array and by individual host on each array. The displayed data represents the volumes that are connected to a host on the current array and the volumes that are connected to a host on any remote arrays that are visible to the current array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_performance_by_array_get_with_http_info(authorization, x_request_id, end_time, filter, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourcePerformanceNoIdByArrayGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_performance_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List host performance data # noqa: E501

Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all hosts, displayed by host and by total size across all hosts. This data represents volumes that are connected to the hosts on the local array and stretched volumes connected to the hosts on any arrays that are connected by synchronous replication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_performance_get_with_http_info(authorization, x_request_id, end_time, filter, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourcePerformanceNoIdGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_post_with_http_info(host: HostPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a host # noqa: E501

Creates a host. The names query parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_post_with_http_info(host, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• host (HostPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(HostResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_protection_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a host from a protection group # noqa: E501

Deletes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed are not affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_protection_groups_delete_with_http_info(authorization, x_request_id, group_ids, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_hosts_protection_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List hosts that are members of protection groups # noqa: E501

Displays a list of host members that belong to one or more protection groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_protection_groups_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_ids, group_names, limit, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_protection_groups_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a host # noqa: E501

Creates a host member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_protection_groups_post_with_http_info(authorization, x_request_id, group_ids, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_space_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List host space information # noqa: E501

Displays provisioned size and physical storage consumption data for each host. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_space_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourceSpaceNoIdGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_tags_batch_put_with_http_info(tag: ConstrainedListValue[NonCopyableTag], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Update tags # noqa: E501

Updates tags. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_tags_batch_put_with_http_info(tag, authorization, x_request_id, resource_ids, resource_names, async_req=True)
>>> result = thread.get()

Parameters

• tag (List[NonCopyableTag]) – A list of tags to be created or, if already existing, updated. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TagResponse, status_code(int), headers(HTTPHeaderDict))

api236_hosts_tags_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete tags # noqa: E501

Deletes specified tags on host objects. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_tags_delete_with_http_info(authorization, x_request_id, keys, namespaces, resource_ids, resource_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_hosts_tags_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List tags # noqa: E501

Displays the list of tags on host objects. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_hosts_tags_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, namespaces, offset, resource_ids, resource_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• namespaces (List[str]) – A comma-separated list of namespaces.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TagGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.kmip_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.kmip_api.KMIPApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_kmip_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete KMIP server object # noqa: E501

Deletes KMIP server objects. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_kmip_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_kmip_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List KMIP server objects # noqa: E501

Displays the list of KMIP server objects. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_kmip_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(KmipGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_kmip_patch_with_http_info(kmip: KmipPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify KMIP attributes # noqa: E501

Modifies one or more attributes of KMIP server objects. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_kmip_patch_with_http_info(kmip, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• kmip (KmipPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(KmipResponse, status_code(int), headers(HTTPHeaderDict))

api236_kmip_post_with_http_info(kmip: KmipPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create KMIP server object # noqa: E501

Creates KMIP server objects. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_kmip_post_with_http_info(kmip, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• kmip (KmipPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(KmipResponse, status_code(int), headers(HTTPHeaderDict))

api236_kmip_test_get_with_http_info(names: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Lists KMIP connection tests # noqa: E501

Displays communication data between a FlashArray and KMIP server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_kmip_test_get_with_http_info(names, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(KmipTestResultGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.log_targets_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.log_targets_api.LogTargetsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_log_targets_file_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a file log target # noqa: E501

Deletes a configured file log target. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_file_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_log_targets_file_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List file log targets # noqa: E501

Displays a list of configured file log targets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_file_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LogTargetFileGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_log_targets_file_patch_with_http_info(log_target_file: LogTargetFile, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a file log target # noqa: E501

Modifies the managed directory and retention of a configured file log target. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_file_patch_with_http_info(log_target_file, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• log_target_file (LogTargetFile) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LogTargetFileResponse, status_code(int), headers(HTTPHeaderDict))

api236_log_targets_file_post_with_http_info(log_target_file: LogTargetFile, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a file log target # noqa: E501

Creates a new file log target. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_file_post_with_http_info(log_target_file, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• log_target_file (LogTargetFile) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LogTargetFileResponse, status_code(int), headers(HTTPHeaderDict))

api236_log_targets_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List log targets # noqa: E501

Displays a list of configured log targets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(LogTargetsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_log_targets_syslog_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete syslog server # noqa: E501

Deletes a configured syslog server and stop forwarding syslog messages. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_syslog_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_log_targets_syslog_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List syslog servers # noqa: E501

Displays a list of configured syslog servers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_syslog_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_log_targets_syslog_patch_with_http_info(syslog_server: SyslogServer, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify syslog server # noqa: E501

Modifies the URI and services of a configured syslog server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_syslog_patch_with_http_info(syslog_server, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• syslog_server (SyslogServer) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerResponse, status_code(int), headers(HTTPHeaderDict))

api236_log_targets_syslog_post_with_http_info(syslog_server: SyslogServer, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create syslog server # noqa: E501

Creates a new syslog server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_syslog_post_with_http_info(syslog_server, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• syslog_server (SyslogServer) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerResponse, status_code(int), headers(HTTPHeaderDict))

api236_log_targets_syslog_settings_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List syslog settings # noqa: E501

Displays syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_syslog_settings_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerSettingsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_log_targets_syslog_settings_patch_with_http_info(syslog_server_settings: SyslogServerSettings, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify syslog settings # noqa: E501

Modifies syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_syslog_settings_patch_with_http_info(syslog_server_settings, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• syslog_server_settings (SyslogServerSettings) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerSettingsResponse, status_code(int), headers(HTTPHeaderDict))

api236_log_targets_syslog_test_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List syslog server test results # noqa: E501

Displays syslog server test results, which indicate whether the syslog is working and configured correctly. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_log_targets_syslog_test_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.maintenance_windows_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.maintenance_windows_api.MaintenanceWindowsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_maintenance_windows_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete maintenance window # noqa: E501

Deletes an open maintenance window before its scheduled end (expire) time. The names parameter is required and must be set to environment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_maintenance_windows_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_maintenance_windows_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List maintenance window details # noqa: E501

Displays maintenance window details, including start time, end time, and maintenance type. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_maintenance_windows_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MaintenanceWindowsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_maintenance_windows_post_with_http_info(maintenance_window: MaintenanceWindowPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a maintenance window # noqa: E501

Creates a maintenance window that suppresses alerts for a specified period of time. A maintenance window can be manually closed at any time. The names and timeout parameters are required. Set the names parameter to environment. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_maintenance_windows_post_with_http_info(maintenance_window, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• maintenance_window (MaintenanceWindowPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MaintenanceWindowsResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.network_interfaces_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.network_interfaces_api.NetworkInterfacesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_network_interfaces_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete network interface # noqa: E501

Deletes a network interface on a controller. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_network_interfaces_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_network_interfaces_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List network interfaces # noqa: E501

Displays all network interfaces for all controllers on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_network_interfaces_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfaceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_network_interfaces_neighbors_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, local_port_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List network interface neighbors # noqa: E501

Displays all neighbors for all network interfaces on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_network_interfaces_neighbors_get_with_http_info(authorization, x_request_id, filter, limit, local_port_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_port_names (List[str]) – Performs the operation on the unique local port name specified. Enter multiple names in comma-separated format. For example, ct0.eth0,ct1.eth0.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfaceNeighborGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_network_interfaces_patch_with_http_info(network: NetworkInterfacePatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify network interface # noqa: E501

Modifies a network interface on a controller. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_network_interfaces_patch_with_http_info(network, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• network (NetworkInterfacePatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfaceResponse, status_code(int), headers(HTTPHeaderDict))

api236_network_interfaces_performance_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List network performance statistics # noqa: E501

Displays network statistics, historical bandwidth, and error reporting for all specified network interfaces. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_network_interfaces_performance_get_with_http_info(authorization, x_request_id, end_time, filter, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfacePerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_network_interfaces_port_details_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SFP port details # noqa: E501

Displays Ethernet and Fibre Channel SFP details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_network_interfaces_port_details_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfacesPortDetailsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_network_interfaces_post_with_http_info(network: NetworkInterfacePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create network interface # noqa: E501

Creates a network interface on a controller on the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_network_interfaces_post_with_http_info(network, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• network (NetworkInterfacePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(NetworkInterfaceResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.offloads_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.offloads_api.OffloadsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_offloads_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete offload target # noqa: E501

Deletes an offload target. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_offloads_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_offloads_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List offload targets # noqa: E501

Displays a list of offload targets that are connected to the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_offloads_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, protocol, sort, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are azure, google-cloud, nfs, and s3.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(OffloadGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_offloads_post_with_http_info(offload: OffloadPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, initialize: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create offload target # noqa: E501

Creates an offload target, connecting it to an array. Before you can connect to, manage, and replicate to an offload target, the Purity Run app must be installed. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_offloads_post_with_http_info(offload, authorization, x_request_id, initialize, names, async_req=True)
>>> result = thread.get()

Parameters

• offload (OffloadPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• initialize (bool) – If set to true, initializes the Amazon S3/Azure Blob container/Google Cloud Storage in preparation for offloading. The parameter must be set to true if this is the first time the array is connecting to the offload target.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(OffloadResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.pod_replica_links_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.pod_replica_links_api.PodReplicaLinksApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_pod_replica_links_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete pod replica links # noqa: E501

Deletes pod replica links. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused ` indicates that data transfer between objects has stopped. A status of `unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pod_replica_links_delete_with_http_info(authorization, x_request_id, ids, local_pod_ids, local_pod_names, remote_pod_ids, remote_pod_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• local_pod_ids (List[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (List[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• remote_pod_ids (List[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (List[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_pod_replica_links_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List pod replica links # noqa: E501

Displays the list of pod replica links that are configured between arrays. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pod_replica_links_get_with_http_info(authorization, x_request_id, filter, ids, limit, local_pod_ids, local_pod_names, offset, remote_ids, remote_names, remote_pod_ids, remote_pod_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (List[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (List[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (List[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (List[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodReplicaLinkGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pod_replica_links_lag_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List pod replica link lag # noqa: E501

Displays the lag in milliseconds that the replication target is behind the source. This is the time difference between the current time and the recovery point. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pod_replica_links_lag_get_with_http_info(authorization, x_request_id, end_time, filter, ids, limit, local_pod_ids, local_pod_names, offset, remote_ids, remote_names, remote_pod_ids, remote_pod_names, resolution, sort, start_time, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (List[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (List[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (List[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (List[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodReplicaLinkLagGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pod_replica_links_mappings_policies_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, pod_replica_link_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List policy mappings # noqa: E501

Displays a list of policy mappings. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pod_replica_links_mappings_policies_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, local_pod_ids, local_pod_names, offset, pod_replica_link_ids, remote_ids, remote_names, remote_pod_ids, remote_pod_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (List[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (List[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• pod_replica_link_ids (List[str]) – A comma-separated list of pod replica link IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (List[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (List[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodReplicaLinkMappingPolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pod_replica_links_mappings_policies_patch_with_http_info(mapping: MappingPolicyPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, pod_replica_link_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify policy mappings # noqa: E501

Modifies policy mappings of a replica link. Valid mapping values are connected and disconnected. connected indicates that the source policy and its attachments will be mirrored on the target pod. disconnected indicates that the associated policy and its attachments are independent from any policy on the remote. This operation can only be performed on the target side of a pod replica link. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pod_replica_links_mappings_policies_patch_with_http_info(mapping, authorization, x_request_id, ids, local_pod_ids, local_pod_names, pod_replica_link_ids, remote_ids, remote_names, remote_pod_ids, remote_pod_names, remote_policy_ids, remote_policy_names, async_req=True)
>>> result = thread.get()

Parameters

• mapping (MappingPolicyPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• local_pod_ids (List[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (List[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• pod_replica_link_ids (List[str]) – A comma-separated list of pod replica link IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (List[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (List[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• remote_policy_ids (List[str]) – A comma-separated list of remote policy IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_policy_names query parameter.

• remote_policy_names (List[str]) – A comma-separated list of remote policy names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_policy_ids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodReplicaLinkMappingPolicyResponse, status_code(int), headers(HTTPHeaderDict))

api236_pod_replica_links_patch_with_http_info(pod_replica_link: PodReplicaLinkPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify pod replica links # noqa: E501

Modifies pod replica links. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused ` indicates that data transfer between objects has stopped. A status of `unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pod_replica_links_patch_with_http_info(pod_replica_link, authorization, x_request_id, ids, local_pod_ids, local_pod_names, remote_ids, remote_names, remote_pod_ids, remote_pod_names, async_req=True)
>>> result = thread.get()

Parameters

• pod_replica_link (PodReplicaLinkPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• local_pod_ids (List[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (List[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (List[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (List[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodReplicaLinkResponse, status_code(int), headers(HTTPHeaderDict))

api236_pod_replica_links_performance_replication_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

api236_pod_replica_links_performance_replication_get # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pod_replica_links_performance_replication_get_with_http_info(authorization, x_request_id, end_time, filter, ids, limit, local_pod_ids, local_pod_names, offset, remote_ids, remote_names, remote_pod_ids, remote_pod_names, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• local_pod_ids (List[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (List[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (List[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (List[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, only return the aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from start_time to end_time. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodReplicaLinkPerformanceReplicationGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pod_replica_links_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, local_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, local_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, remote_pod_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create pod replica links # noqa: E501

Creates pod replica links between two arrays. The local_pod_names and remote_pod_names are required. Valid values are replicating, baselining, paused, unhealthy, quiescing, and quiesced. A status of replicating indicates that the source array is replicating to the target array. A status of baselining indicates that the the initial version of the dataset is being sent. During this phase, you cannot promote the target pod. In addition, changing the link direction might trigger the baselining status to recur. A status of paused ` indicates that data transfer between objects has stopped. A status of `unhealthy indicates that the link is currently unhealthy and customers must perform some health checks to determine the cause. A status of quiescing indicates that the source pod is not accepting new write requests but the most recent changes to the source have not arrived on the target. A status of quiesced indicates that the source pod has been demoted and all changes have been replicated to the target pod. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pod_replica_links_post_with_http_info(authorization, x_request_id, local_pod_ids, local_pod_names, remote_ids, remote_names, remote_pod_ids, remote_pod_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• local_pod_ids (List[str]) – A comma-separated list of local pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_names query parameter.

• local_pod_names (List[str]) – A comma-separated list of local pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the local_pod_ids query parameter.

• remote_ids (List[str]) – A comma-separated list of remote array IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_names query parameter.

• remote_names (List[str]) – A comma-separated list of remote array names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_ids query parameter.

• remote_pod_ids (List[str]) – A comma-separated list of remote pod IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_names query parameter.

• remote_pod_names (List[str]) – A comma-separated list of remote pod names. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the remote_pod_ids query parameter.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodReplicaLinkResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.pods_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.pods_api.PodsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_pods_arrays_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, with_unknown: Optional[StrictBool] = None, **kwargs) → ApiResponse

Unstretch a pod from an array # noqa: E501

This field has been deprecated. Use pods/members instead. Unstretches a pod from an array, collapsing the pod to a single array. Unstretch a pod from an array when the volumes within the stretched pod no longer need to be synchronously replicated between the two arrays. After a pod has been unstretched, synchronous replication stops. A destroyed version of the pod with “restretch” appended to the pod name is created on the array that no longer has the pod. The restretch pod represents a point-in-time snapshot of the pod, just before it was unstretched. The restretch pod enters an eradication pending period starting from the time that the pod was unstretched. A restretch can pod can be cloned or destroyed, but it cannot be explicitly recovered. The group_names parameter represents the name of the pod to be unstretched. The member_names parameter represents the name of the array from which the pod is to be unstretched. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_arrays_delete_with_http_info(authorization, x_request_id, group_ids, group_names, member_ids, member_names, with_unknown, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• with_unknown (bool) – If set to true, unstretches the specified pod from the specified array by force. Use the with_unknown parameter in the following rare event&#58; the local array goes offline while the pod is still stretched across two arrays, the status of the remote array becomes unknown, and there is no guarantee that the pod is online elsewhere.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_pods_arrays_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List pods and their the array members # noqa: E501

This field has been deprecated. Use pods/members instead. Returns a list of pods and the local and remote arrays over which the pods are stretched. Pods with realm members will not be returned. The optional group_names parameter represents the name of the pod. The optional member_names parameter represents the name of the array over which the pod is stretched. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_arrays_get_with_http_info(authorization, x_request_id, filter, group_ids, group_names, limit, member_ids, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_arrays_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Stretch a pod to an array # noqa: E501

This field has been deprecated. Use pods/members instead. Stretches a pod to an array. When a pod is stretched to an array, the data in the arrays over which the pod is stretched is synchronously replicated. The group_names parameter represents the name of the pod to be stretched. The member_names parameter represents the name of the array over which the pod is to be stretched. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_arrays_post_with_http_info(authorization, x_request_id, group_ids, group_names, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, eradicate_contents: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a pod # noqa: E501

Deletes a pod that has been destroyed and is pending eradication. Eradicated pods cannot be recovered. Pods are destroyed using the PATCH method. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_delete_with_http_info(authorization, x_request_id, eradicate_contents, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• eradicate_contents (bool) – Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups). This enables you to eradicate containers with contents.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_pods_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List pods # noqa: E501

Displays a list of pods that are stretched to this array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, pod_names: Optional[ConstrainedListValue[StrictStr]] = None, with_unknown: Optional[StrictBool] = None, **kwargs) → ApiResponse

Delete a member from a pod # noqa: E501

Unstretches a pod from an array, collapsing the pod to a member array. Unstretch a pod from an array when the volumes within the stretched pod no longer need to be synchronously replicated between the two members. After a pod has been unstretched, synchronous replication stops. A destroyed version of the pod with “restretch” appended to the pod name is created on the member that no longer has the pod. The restretch pod represents a point-in-time snapshot of the pod, just before it was unstretched. The restretch pod enters an eradication pending period starting from the time that the pod was unstretched. A restretch can pod can be cloned or destroyed, but it cannot be explicitly recovered. The member_names parameter represents the name of the array from which the pod is to be unstretched. Both pod and member must be specified by name or ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_members_delete_with_http_info(authorization, x_request_id, member_ids, member_names, pod_ids, pod_names, with_unknown, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• pod_ids (List[str]) – A comma-separated list of pod IDs.

• pod_names (List[str]) – Performs the operation on the unique pod name specified. Enter multiple names in comma-separated format. For example, pod01,pod02.

• with_unknown (bool) – If set to true, unstretches the specified pod from the specified array by force. Use the with_unknown parameter in the following rare event&#58; the local array goes offline while the pod is still stretched across two arrays, the status of the remote array becomes unknown, and there is no guarantee that the pod is online elsewhere.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_pods_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, pod_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List pods and their members # noqa: E501

Displays a list of pods and the local and remote members over which the pods are stretched. Currently either array or realm is supported as member. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_members_get_with_http_info(authorization, x_request_id, filter, limit, member_ids, member_names, offset, pod_ids, pod_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• pod_ids (List[str]) – A comma-separated list of pod IDs.

• pod_names (List[str]) – Performs the operation on the unique pod name specified. Enter multiple names in comma-separated format. For example, pod01,pod02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_members_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, pod_ids: Optional[ConstrainedListValue[StrictStr]] = None, pod_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Creatse a member to add to a pod # noqa: E501

Creates a stretched pod on an array. When a pod is stretched to an array, the data in the arrays over which the pod is stretched is synchronously replicated. The member_names or member_ids parameter represents the array over which the pod is to be stretched. Both pod and member must be specified by name or ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_members_post_with_http_info(authorization, x_request_id, member_ids, member_names, pod_ids, pod_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• pod_ids (List[str]) – A comma-separated list of pod IDs.

• pod_names (List[str]) – Performs the operation on the unique pod name specified. Enter multiple names in comma-separated format. For example, pod01,pod02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_patch_with_http_info(pod: PodPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, abort_quiesce: Optional[StrictBool] = None, destroy_contents: Optional[StrictBool] = None, from_member_ids: Optional[ConstrainedListValue[StrictStr]] = None, from_member_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, move_with_host_group_names: Optional[ConstrainedListValue[StrictStr]] = None, move_with_host_names: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, promote_from: Optional[StrictStr] = None, quiesce: Optional[StrictBool] = None, skip_quiesce: Optional[StrictBool] = None, to_member_ids: Optional[ConstrainedListValue[StrictStr]] = None, to_member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a pod # noqa: E501

Modifies pod details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_patch_with_http_info(pod, authorization, x_request_id, abort_quiesce, destroy_contents, from_member_ids, from_member_names, ids, move_with_host_group_names, move_with_host_names, names, promote_from, quiesce, skip_quiesce, to_member_ids, to_member_names, async_req=True)
>>> result = thread.get()

Parameters

• pod (PodPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• abort_quiesce (bool) – Set to true to promote the pod when the pod-replica-link is in the quiescing state and abort when waiting for the pod-replica-link to complete the quiescing operation.

• destroy_contents (bool) – Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups), including eradicating containers with content.

• from_member_ids (List[str]) – Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays from which the resource should be removed. Enter multiple IDs in a comma-separated format.

• from_member_names (List[str]) – Move the resource from the specified local member realm or array. This should be a union of all local realms and arrays to be removed from the specified resource. Enter multiple names in a comma-separated format.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• move_with_host_group_names (List[str]) – The host groups to be moved together with the pods to the specified local member realm or array. All the hosts in the host groups will also be moved. Enter multiple names in a comma-separated format.

• move_with_host_names (List[str]) – The hosts to be moved together with the pods to the specified local member realm or array. Enter multiple names in a comma-separated format.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• promote_from (str) – The undo-demote pod that should be used to promote the pod. After the pod has been promoted, it will have the same data as the undo-demote pod and the undo-demote pod will be eradicated.

• quiesce (bool) – Set to true to demote the pod after the pod-replica-link goes into quiesced state and allow the pod to become a target of the remote pod. This ensures that all local data has been replicated to the remote pod before the pod is demoted.

• skip_quiesce (bool) – Set to true to demote the pod without quiescing the pod-replica-link and allow the pod to become a target of the remote pod. This stops all pending replication to the remote pod.

• to_member_ids (List[str]) – The resource will be moved to the specified local member realm or array. Enter multiple IDs in a comma-separated format.

• to_member_names (List[str]) – The resource will be moved to the specified local member realm or array. Enter multiple names in a comma-separated format.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_performance_by_array_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, protocol_group: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List pod performance data by array # noqa: E501

Displays real-time and historical performance data, real-time latency data, and average I/O size data. The data is displayed as a total across all pods on the local array and by individual pod. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_performance_by_array_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, protocol, protocol_group, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodPerformanceByArrayGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_performance_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, protocol: Optional[StrictStr] = None, protocol_group: Optional[StrictStr] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List pod performance data # noqa: E501

Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all pods, displayed both by pod and as a total across all pods. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_performance_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, protocol, protocol_group, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol (str) – Protocol type. Valid values are nfs, smb, and all.

• protocol_group (str) – Protocol group type. Valid values are block, file, and all.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ContainerPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_performance_replication_by_array_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List pod replication performance data by array # noqa: E501

Displays pod replication performance data, organized by array. The data returned is the real-time and historical performance data for each replication type at the pod level. Values include continuous, periodic, resync, and sync. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_performance_replication_by_array_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodPerformanceReplicationByArrayGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_performance_replication_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List pod replication performance data # noqa: E501

Displays pod replication performance data. The data returned is the real-time and historical performance data for each replication type at the pod level. Values include continuous, periodic, resync, and sync. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_performance_replication_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, only return the aggregate value of all items after filtering. For real-time performance, the values are aggregated for the latest timestamp. For historical performance, the values are aggregated for each timestamp from start_time to end_time. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodPerformanceReplicationGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_post_with_http_info(pod: PodPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a pod # noqa: E501

Creates a pod on the local array. Each pod must be given a unique name across the arrays to which they are stretched. A pod cannot be stretched to an array that already contains a pod with the same name. After a pod has been created, add volumes and protection groups, and then stretch the pod to another connected array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_post_with_http_info(pod, authorization, x_request_id, allow_throttle, names, async_req=True)
>>> result = thread.get()

Parameters

• pod (PodPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PodResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_space_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List pod space information # noqa: E501

Displays provisioned size and physical storage consumption data for each pod on the local array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_space_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourcePodSpaceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_pods_test_post_with_http_info(pod: PodPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create an attempt to clone a pod # noqa: E501

Creates an attempt to clone a pod on the local array without actually cloning it, to test if the pod can be successfully cloned. It does not suppport pod creation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_pods_test_post_with_http_info(pod, authorization, x_request_id, allow_throttle, names, async_req=True)
>>> result = thread.get()

Parameters

• pod (PodPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceWithIdPostResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.policies_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.policies_api.PoliciesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_policies_alert_watcher_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete alert-watcher policies # noqa: E501

Deletes one or more alert-watcher policies. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_alert_watcher_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List alert-watcher policies # noqa: E501

Displays a list of alert-watcher policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_alert_watcher_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete membership between alert-watcher policies and attached object # noqa: E501

Deletes a membership between one or more alert-watcher policies and attached object. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_members_delete_with_http_info(authorization, x_request_id, member_ids, member_names, member_types, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_alert_watcher_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List alert-watcher policy members # noqa: E501

Displays a list of alert-watcher policy members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_members_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, member_types, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_alert_watcher_members_post_with_http_info(members: PolicyMemberPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between an object and an alert-watcher policy # noqa: E501

Creates a membership between one or more objects and an alert-watcher policy. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_members_post_with_http_info(members, authorization, x_request_id, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• members (PolicyMemberPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_alert_watcher_patch_with_http_info(policy: PolicyPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify alert-watcher policies # noqa: E501

Modifies one or more alert-watcher policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_patch_with_http_info(policy, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• policy (PolicyPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_alert_watcher_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyPost] = None, **kwargs) → ApiResponse

Create alert-watcher policies # noqa: E501

Creates one or more alert-watcher policies. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_post_with_http_info(authorization, x_request_id, names, source_ids, source_names, policy, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicyPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_alert_watcher_rules_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete alert-watcher policy rules # noqa: E501

Deletes one or more alert-watcher policy rules. Either the ‘policy_ids’ or ‘policy_names’ parameter is required, but both parameters cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_rules_delete_with_http_info(authorization, x_request_id, names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_alert_watcher_rules_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List alert-watcher policy rules # noqa: E501

Displays a list of alert-watcher policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_rules_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleAlertWatcherGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_alert_watcher_rules_patch_with_http_info(rules: PolicyRuleAlertWatcherPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify alert-watcher policy rules # noqa: E501

Modifies alert-watcher policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_rules_patch_with_http_info(rules, authorization, x_request_id, names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• rules (PolicyRuleAlertWatcherPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleAlertWatcherResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_alert_watcher_rules_post_with_http_info(rules: PolicyRuleAlertWatcherPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create alert-watcher policy rules # noqa: E501

Creates one or more alert-watcher policy rules. Either the ‘policy_ids’ or ‘policy_names’ parameter is required, but both parameters cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_rules_post_with_http_info(rules, authorization, x_request_id, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• rules (PolicyRuleAlertWatcherPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleAlertWatcherResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_alert_watcher_rules_test_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List rules of alert-watcher policy rule test # noqa: E501

Displays alert-watcher policy rule email test results. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_alert_watcher_rules_test_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_audit_file_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete audit policies # noqa: E501

Deletes one or more audit policies. Either the ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_audit_file_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_audit_file_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List audit policies # noqa: E501

Displays a list of audit policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_audit_file_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyAuditFileGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_audit_file_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete membership between audit policies and managed directories # noqa: E501

Deletes a membership between one or more audit policies and managed directories. Either the policy_ids or policy_names parameter is required, but they cannot be set together. Either the member_ids or member_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_audit_file_members_delete_with_http_info(authorization, x_request_id, member_ids, member_names, member_types, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_audit_file_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List audit policy members # noqa: E501

Displays a list of audit policy members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_audit_file_members_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, member_types, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_audit_file_members_post_with_http_info(members: PolicyMemberPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between a managed directory and a audit policy # noqa: E501

Creates a membership between one or more managed directories and an audit policy. Either the policy_ids or policy_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_audit_file_members_post_with_http_info(members, authorization, x_request_id, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• members (PolicyMemberPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_audit_file_patch_with_http_info(policy: PolicyAuditFilePatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify audit policies # noqa: E501

Modifies one or more audit policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. Either the ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_audit_file_patch_with_http_info(policy, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• policy (PolicyAuditFilePatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyAuditFileResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_audit_file_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyAuditFilePost] = None, **kwargs) → ApiResponse

Create audit policies # noqa: E501

Creates one or more audit policies. To copy a policy, either the source_names or source_ids parameter is required, but they cannot be set together. To create a policy from scratch, the policy body is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_audit_file_post_with_http_info(authorization, x_request_id, names, source_ids, source_names, policy, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicyAuditFilePost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyAuditFileResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_autodir_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete auto managed directory policies # noqa: E501

Deletes one or more auto managed directory policies. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_autodir_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_autodir_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List auto managed directory policies # noqa: E501

Displays a list of auto managed directory policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_autodir_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_autodir_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete auto managed directory policies # noqa: E501

Deletes one or more auto managed directory policies from resources. The policy_ids or policy_names parameter is required, but they cannot be set together. The member_ids or member_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_autodir_members_delete_with_http_info(authorization, x_request_id, member_ids, member_names, member_types, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_autodir_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List auto managed directories policy members # noqa: E501

Displays a list of auto managed directory policy members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_autodir_members_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, member_types, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_autodir_members_post_with_http_info(members: PolicyMemberPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create auto managed directory policies # noqa: E501

Creates a membership between one or more resources with an auto managed directory policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_autodir_members_post_with_http_info(members, authorization, x_request_id, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• members (PolicyMemberPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_autodir_patch_with_http_info(policy: PolicyPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify auto managed directory policies # noqa: E501

Modifies one or more auto managed directory policies. To enable a policy, set enabled=true. To disable a policy, set enabled=true. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_autodir_patch_with_http_info(policy, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• policy (PolicyPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_autodir_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyPost] = None, **kwargs) → ApiResponse

Create auto managed directory policies # noqa: E501

Creates one or more auto managed directory policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_autodir_post_with_http_info(authorization, x_request_id, names, source_ids, source_names, policy, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicyPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List policies # noqa: E501

Displays a list of policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_management_access_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete management access policies # noqa: E501

Deletes one or more management access policies. The ids or names is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_management_access_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_management_access_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List management access policies # noqa: E501

Displays a list of management access policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_management_access_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyManagementAccessGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_management_access_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete membership between management access policies and attached object # noqa: E501

Deletes a membership between one or more management access policies and attached object. The`policy_ids` or policy_names is required, but they cannot be set together. The member_ids or member_names. member_types is also required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_management_access_members_delete_with_http_info(authorization, x_request_id, member_ids, member_names, member_types, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in a comma-separated format.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_management_access_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List management access policy members # noqa: E501

Displays a list of management access policy members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_management_access_members_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, member_ids, member_names, member_types, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in a comma-separated format.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in a comma-separated format.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberCleanGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_management_access_members_post_with_http_info(members: PolicyMemberPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between an object and a management access policy # noqa: E501

Creates a membership between one or more objects and a management access policy. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_management_access_members_post_with_http_info(members, authorization, x_request_id, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• members (PolicyMemberPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in a comma-separated format.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberCleanResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_management_access_patch_with_http_info(policy: PolicyManagementAccessPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify management access policies # noqa: E501

Modifies one or more management access policies. The ids or names is required, but they cannot be set together. For renames, can only specify one old policy in ids or names. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_management_access_patch_with_http_info(policy, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• policy (PolicyManagementAccessPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyManagementAccessResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_management_access_post_with_http_info(names: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyManagementAccessPost] = None, **kwargs) → ApiResponse

Create management access policies # noqa: E501

Creates one or more management access policies. To copy a policy, the`source_names` or source_ids is required, but they cannot be set together. To create a policy from scratch, policy body is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_management_access_post_with_http_info(names, authorization, x_request_id, source_ids, source_names, policy, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicyManagementAccessPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyManagementAccessResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List policy members # noqa: E501

Displays a list of policy members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_members_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, member_types, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_nfs_client_rules_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete NFS client policy rules. # noqa: E501

Deletes one or more NFS client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_nfs_client_rules_delete_with_http_info(authorization, x_request_id, names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_nfs_client_rules_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List NFS client policy rules # noqa: E501

Displays a list of NFS client policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_nfs_client_rules_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleNfsClientGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_nfs_client_rules_post_with_http_info(rules: PolicyRuleNfsClientPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create NFS client policy rules # noqa: E501

Creates one or more NFS client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_nfs_client_rules_post_with_http_info(rules, authorization, x_request_id, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• rules (PolicyRuleNfsClientPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleNfsClientResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_nfs_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete NFS policies # noqa: E501

Deletes one or more NFS policies. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_nfs_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_nfs_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List NFS policies # noqa: E501

Displays a list of NFS policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_nfs_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyNfsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_nfs_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete NFS policies # noqa: E501

Deletes one or more NFS policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_nfs_members_delete_with_http_info(authorization, x_request_id, member_ids, member_names, member_types, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_nfs_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List NFS policy members # noqa: E501

Displays a list of NFS policy members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_nfs_members_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, member_types, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberExportGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_nfs_members_post_with_http_info(members: PolicyMemberExportPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create NFS policies # noqa: E501

Creates a membership between one or more resources and an NFS policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_nfs_members_post_with_http_info(members, authorization, x_request_id, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• members (PolicyMemberExportPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberExportResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_nfs_patch_with_http_info(policy: PolicyNfsPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify NFS policies # noqa: E501

Modifies one or more NFS policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_nfs_patch_with_http_info(policy, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• policy (PolicyNfsPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyNfsResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_nfs_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyNfsPost] = None, **kwargs) → ApiResponse

Create NFS policies # noqa: E501

Creates one or more NFS policies or copies an existing policy. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy, policy body is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_nfs_post_with_http_info(authorization, x_request_id, names, source_ids, source_names, policy, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicyNfsPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyNfsResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_password_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List password policies # noqa: E501

Displays a list of password policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_password_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyPasswordGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_password_patch_with_http_info(policy: PolicyPassword, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify password policies # noqa: E501

Modifies one or more password policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_password_patch_with_http_info(policy, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• policy (PolicyPassword) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyPasswordResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_quota_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete quota policies # noqa: E501

Deletes one or more quota policies. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_quota_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_quota_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List quota policies # noqa: E501

Displays a list of quota policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_quota_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_quota_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete membership between quota policies and managed directories # noqa: E501

Deletes a membership between one or more quota policies and managed directories. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_quota_members_delete_with_http_info(authorization, x_request_id, member_ids, member_names, member_types, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_quota_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List quota policy members # noqa: E501

Displays a list of quota policy members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_quota_members_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, member_types, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_quota_members_post_with_http_info(members: PolicyMemberPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ignore_usage: Optional[StrictBool] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a membership between a managed directory and a quota policy # noqa: E501

Creates a membership between one or more managed directories and a quota policy. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_quota_members_post_with_http_info(members, authorization, x_request_id, ignore_usage, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• members (PolicyMemberPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ignore_usage (bool) – Flag used to override checks for quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_quota_patch_with_http_info(policy: PolicyPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify quota policies # noqa: E501

Modifies one or more quota policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_quota_patch_with_http_info(policy, authorization, x_request_id, ids, ignore_usage, names, async_req=True)
>>> result = thread.get()

Parameters

• policy (PolicyPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• ignore_usage (bool) – Flag used to override checks for quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_quota_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyPost] = None, **kwargs) → ApiResponse

Create quota policies # noqa: E501

Creates one or more quota policies. To copy a policy, the source_names or source_ids parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_quota_post_with_http_info(authorization, x_request_id, names, source_ids, source_names, policy, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicyPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_quota_rules_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete quota policy rules # noqa: E501

Deletes one or more quota policy rules. The policy_ids or policy_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_quota_rules_delete_with_http_info(authorization, x_request_id, names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_quota_rules_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List quota policy rules # noqa: E501

Displays a list of quota policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_quota_rules_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleQuotaGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_quota_rules_patch_with_http_info(rules: PolicyRuleQuotaPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ignore_usage: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify quota policy rules # noqa: E501

Modifies quota policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_quota_rules_patch_with_http_info(rules, authorization, x_request_id, ignore_usage, names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• rules (PolicyRuleQuotaPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ignore_usage (bool) – Flag used to override checks for quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleQuotaResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_quota_rules_post_with_http_info(rules: PolicyRuleQuotaPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ignore_usage: Optional[StrictBool] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create quota policy rules # noqa: E501

Creates one or more quota policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_quota_rules_post_with_http_info(rules, authorization, x_request_id, ignore_usage, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• rules (PolicyRuleQuotaPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ignore_usage (bool) – Flag used to override checks for quota management operations. If set to true, directory usage is not checked against the quota_limits that are set. If set to false, the actual logical bytes in use are prevented from exceeding the limits set on the directory. Client operations might be impacted. If the limit exceeds the quota, the client operation is not allowed. If not specified, defaults to false.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleQuotaResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_smb_client_rules_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete SMB client policy rules. # noqa: E501

Deletes one or more SMB client policy rules. The policy_ids or policy_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_smb_client_rules_delete_with_http_info(authorization, x_request_id, names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_smb_client_rules_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SMB client policy rules # noqa: E501

Displays a list of SMB client policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_smb_client_rules_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleSmbClientGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_smb_client_rules_post_with_http_info(rules: PolicyRuleSmbClientPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create SMB client policy rules # noqa: E501

Creates one or more SMB client policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_smb_client_rules_post_with_http_info(rules, authorization, x_request_id, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• rules (PolicyRuleSmbClientPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleSmbClientResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_smb_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete SMB policies # noqa: E501

Deletes one or more SMB policies. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_smb_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_smb_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SMB policies # noqa: E501

Displays a list of SMB policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_smb_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicySmbGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_smb_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete SMB policies # noqa: E501

Deletes one or more SMB policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_smb_members_delete_with_http_info(authorization, x_request_id, member_ids, member_names, member_types, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_smb_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SMB policy members # noqa: E501

Displays a list of SMB policy members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_smb_members_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, member_types, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberExportGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_smb_members_post_with_http_info(members: PolicyMemberExportPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create SMB policies # noqa: E501

Creates a membership between one or more resources and an SMB policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_smb_members_post_with_http_info(members, authorization, x_request_id, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• members (PolicyMemberExportPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberExportResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_smb_patch_with_http_info(policy: PolicySmbPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify SMB policies # noqa: E501

Modifies one or more SMB policies. To enable a policy, set enabled=true. To disable a policy, set enabled=false. To enable access based enumeration, set access_based_enumeration_enabled=true. To disable access based enumeration, set access_based_enumeration_enabled=false. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_smb_patch_with_http_info(policy, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• policy (PolicySmbPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicySmbResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_smb_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicySmbPost] = None, **kwargs) → ApiResponse

Create SMB policies # noqa: E501

Creates one or more SMB policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body is required. To create an SMB policy with access based enumeration enabled, set access_based_enumeration_enabled=true. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_smb_post_with_http_info(authorization, x_request_id, names, source_ids, source_names, policy, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicySmbPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicySmbResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_snapshot_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete snapshot policies # noqa: E501

Deletes one or more snapshot policies. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_snapshot_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_snapshot_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List snapshot policies # noqa: E501

Displays a list of snapshot policies. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_snapshot_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_snapshot_members_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete snapshot policies # noqa: E501

Deletes one or more snapshot policies from resources. The policy_ids or policy_names parameter is required, but cannot be set together. The member_ids or member_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_snapshot_members_delete_with_http_info(authorization, x_request_id, member_ids, member_names, member_types, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_snapshot_members_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, member_types: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List snapshot policy members # noqa: E501

Displays a list of snapshot policy members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_snapshot_members_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, member_ids, member_names, member_types, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• member_types (List[str]) – Performs the operation on the member types specified. The type of member is the full name of the resource endpoint. Valid values include directories. Enter multiple member types in comma-separated format. For example, type01,type02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_snapshot_members_post_with_http_info(members: PolicyMemberPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create snapshot policies # noqa: E501

Creates a membership between one or more resources and a snapshot policy. Applicable resources are directories. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_snapshot_members_post_with_http_info(members, authorization, x_request_id, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• members (PolicyMemberPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_snapshot_patch_with_http_info(policy: PolicyPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify snapshot policies # noqa: E501

Modifies one or more snapshot policies. To enable a policy, set enabled=true. To disable a policy, set enabled=true. To rename a policy, set name to the new name. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_snapshot_patch_with_http_info(policy, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• policy (PolicyPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_snapshot_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, policy: Optional[PolicyPost] = None, **kwargs) → ApiResponse

Create snapshot policies # noqa: E501

Creates one or more snapshot policies. To copy a policy, set one of either source_names or source_ids. Each policy can only have one entry. To create a policy from scratch, policy body is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_snapshot_post_with_http_info(authorization, x_request_id, names, source_ids, source_names, policy, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• policy (PolicyPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_snapshot_rules_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete snapshot policy rules # noqa: E501

Deletes one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_snapshot_rules_delete_with_http_info(authorization, x_request_id, names, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_policies_snapshot_rules_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List snapshot policy rules # noqa: E501

Displays a list of snapshot policy rules. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_snapshot_rules_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, names, offset, policy_ids, policy_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleSnapshotGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_policies_snapshot_rules_post_with_http_info(rules: PolicyRuleSnapshotPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, policy_ids: Optional[ConstrainedListValue[StrictStr]] = None, policy_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create snapshot policy rules # noqa: E501

Creates one or more snapshot policy rules. The policy_ids or policy_names parameter is required, but cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_policies_snapshot_rules_post_with_http_info(rules, authorization, x_request_id, policy_ids, policy_names, async_req=True)
>>> result = thread.get()

Parameters

• rules (PolicyRuleSnapshotPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• policy_ids (List[str]) – Performs the operation on the unique policy IDs specified. Enter multiple policy IDs in comma-separated format. The policy_ids or policy_names parameter is required, but they cannot be set together.

• policy_names (List[str]) – Performs the operation on the policy names specified. Enter multiple policy names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PolicyRuleSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.ports_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.ports_api.PortsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_ports_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List ports # noqa: E501

Displays host name, iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), IPv4 address of the portal, Fibre Channel World Wide Names (WWNs), and failover ports, including those that were discovered by Purity//FA and those that have been manually assigned by system administrators. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_ports_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PortGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_ports_initiators_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List port initiators # noqa: E501

Displays host iSCSI Qualified Names (IQNs), NVMe Qualified Names (NQNs), and Fibre Channel World Wide Names (WWNs), including those that were discovered by Purity//FA and those that have been manually assigned by system administrators, along with the array ports (targets) on which they are eligible to communicate. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_ports_initiators_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(PortInitiatorsGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.protection_group_snapshots_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.protection_group_snapshots_api.ProtectionGroupSnapshotsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_protection_group_snapshots_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a protection group snapshot # noqa: E501

Deletes a protection group snapshot that has been destroyed and is pending eradication. Eradicating a protection group snapshot eradicates all of its protection group snapshots and cannot be recovered. Protection group snapshots are destroyed through the PATCH method. The names or ids parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_group_snapshots_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_protection_group_snapshots_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List protection group snapshots # noqa: E501

Displays a list of protection group snapshots, including those pending eradication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_group_snapshots_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, source_ids, source_names, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupSnapshotGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_group_snapshots_patch_with_http_info(protection_group_snapshot: ProtectionGroupSnapshotPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a protection group snapshot # noqa: E501

Modifies a protection group snapshot so that it can be destroyed. To destroy a volume, set destroyed=true. To recover a volume that has been destroyed and is pending eradication, set destroyed=false. The names or ids parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_group_snapshots_patch_with_http_info(protection_group_snapshot, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• protection_group_snapshot (ProtectionGroupSnapshotPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_group_snapshots_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, apply_retention: Optional[StrictBool] = None, for_replication: Optional[StrictBool] = None, replicate: Optional[StrictBool] = None, replicate_now: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, protection_group_snapshot: Optional[ProtectionGroupSnapshotPost] = None, **kwargs) → ApiResponse

Create a protection group snapshot # noqa: E501

Creates a point-in-time snapshot of the contents of a protection group. The source_ids or source_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_group_snapshots_post_with_http_info(authorization, x_request_id, allow_throttle, apply_retention, for_replication, replicate, replicate_now, source_ids, source_names, protection_group_snapshot, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

• for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

• replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

• replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• protection_group_snapshot (ProtectionGroupSnapshotPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_group_snapshots_replica_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, convert_source_to_baseline: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create an action to send protection group snapshots # noqa: E501

Creates an action to send protection group snapshots to protection pgroup targets. When the on option is used, only specified targets will recieve the protection group snapshots. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_group_snapshots_replica_post_with_http_info(authorization, x_request_id, convert_source_to_baseline, ids, names, on, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• convert_source_to_baseline (bool) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (List[str]) – Performs the operation locally with the target names specified as the destinations of the operation. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupSnapshotReplicaResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_group_snapshots_test_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, apply_retention: Optional[StrictBool] = None, for_replication: Optional[StrictBool] = None, replicate: Optional[StrictBool] = None, replicate_now: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, protection_group_snapshot: Optional[ProtectionGroupSnapshotPost] = None, **kwargs) → ApiResponse

Create an attempt to take protection group snapshot # noqa: E501

Creates an attempt to take the protection group snapshot, without actually taking it, to test if the snapshot can be successfully taken. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_group_snapshots_test_post_with_http_info(authorization, x_request_id, allow_throttle, apply_retention, for_replication, replicate, replicate_now, source_ids, source_names, protection_group_snapshot, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

• for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

• replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

• replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• protection_group_snapshot (ProtectionGroupSnapshotPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceWithIdPostResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_group_snapshots_transfer_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List protection group snapshots with transfer statistics # noqa: E501

Displays a list of protection group snapshots and corresponding transfer statistics. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_group_snapshots_transfer_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, source_ids, source_names, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupSnapshotTransferGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.protection_groups_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.protection_groups_api.ProtectionGroupsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_protection_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a protection group # noqa: E501

Deletes a protection group that has been destroyed and is pending eradication. Eradicated protection groups cannot be recovered. Protection groups are destroyed through the PATCH method. The names parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_protection_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List protection groups # noqa: E501

Displays a list of protection groups, including their associated source arrays, replication targets, hosts, host groups, and volumes. The list includes protection groups that were created on the local array to replicate snapshot data to other arrays or offload targets, created on a remote array and replicated asynchronously to this array, or created inside a pod on a remote array and stretched to the local array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_host_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a host group from a protection group # noqa: E501

Deletes a host group member from a protection group. After the member has been removed, it is no longer protected by the group. Protection group snapshots taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_host_groups_delete_with_http_info(authorization, x_request_id, group_ids, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_protection_groups_host_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List protection groups with host group members # noqa: E501

Displays a list of protection groups that have host group members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_host_groups_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_ids, group_names, limit, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_host_groups_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Creates an action to add a host group to a protection group # noqa: E501

Creates an action to add a host group member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host group. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_host_groups_post_with_http_info(authorization, x_request_id, group_ids, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_hosts_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a host from a protection group # noqa: E501

Deletes a host member from a protection group. After the member has been removed, it is no longer protected by the group. Any protection group snapshots that were taken before the member was removed will not be affected. Removing a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_hosts_delete_with_http_info(authorization, x_request_id, group_ids, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_protection_groups_hosts_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List protection groups with host members # noqa: E501

Displays a list of protection groups that have host members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_hosts_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_ids, group_names, limit, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdMemberGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_hosts_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create an action to add a host to a protection group # noqa: E501

Creates an action to add a host member to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names parameter represents the name of the host. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_hosts_post_with_http_info(authorization, x_request_id, group_ids, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberNoIdMemberResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_patch_with_http_info(protection_group: ProtectionGroup, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a protection group # noqa: E501

Modifies the protection group schedules to generate and replicate snapshots to another array or to an external storage system. Renames or destroys a protection group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_patch_with_http_info(protection_group, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• protection_group (ProtectionGroup) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_performance_replication_by_array_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List protection group replication performance data with array details # noqa: E501

Displays the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group and includes the names of the source array and targets for each protection group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_performance_replication_by_array_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupPerformanceArrayResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_performance_replication_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List protection group replication performance data # noqa: E501

Displays the total number of bytes of replication data transmitted and received per second. The data is grouped by protection group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_performance_replication_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupPerformanceResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, overwrite: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a protection group # noqa: E501

Creates a protection group on the local array for asynchronous replication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_post_with_http_info(authorization, x_request_id, names, overwrite, source_ids, source_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• source_ids (List[str]) – The id of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the overwrite parameter to overwrite all of the existing volumes with the snapshot contents. If including the overwrite parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation.

• source_names (List[str]) – The name of the protection group or protection group snapshot to be copied into a new or existing protection group. If the destination protection group and all of its volumes already exist, include the overwrite parameter to overwrite all of the existing volumes with the snapshot contents. If including the overwrite parameter, the names of the volumes that are being overwritten must match the names of the volumes that are being restored. If the source is a protection group, the latest snapshot of the protection group will be used as the source during the copy operation.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_space_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List protection group space information # noqa: E501

Displays provisioned size and physical storage consumption data for each protection group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_space_get_with_http_info(authorization, x_request_id, destroyed, filter, ids, limit, names, offset, sort, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourceSpaceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_targets_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a target from a protection group # noqa: E501

Deletes an array or offload target from a protection group. The group_names parameter represents the name of the protection group. The member_names parameter represents the name of the array or offload target that is being removed from the protection group. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_targets_delete_with_http_info(authorization, x_request_id, group_ids, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_protection_groups_targets_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List protection groups with targets # noqa: E501

Displays a list of protection groups that have target arrays or offload targets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_targets_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_ids, group_names, limit, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupTargetGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_targets_patch_with_http_info(target: TargetProtectionGroupPostPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a protection group target # noqa: E501

Modifies the source array to replicate protection group data to the target array, or disallows the source array from replicating protection group data to the target array. The allowed parameter must be set from the target array. The group_names parameter represents the name of the protection group. The allowed and group_names parameters are required and must be set together. Offload targets do not support the allowed parameter. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_targets_patch_with_http_info(target, authorization, x_request_id, group_ids, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• target (TargetProtectionGroupPostPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupTargetResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_targets_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create an action to add a target to a protection group # noqa: E501

Creates an action to add an array or offload target to a protection group. The group_names parameter represents the name of the protection group. The member_names parameter represents the name of the array or offload target that is being added to the protection group. The group_names and member_names parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_targets_post_with_http_info(authorization, x_request_id, group_ids, group_names, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupTargetResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_volumes_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a volume from a protection group # noqa: E501

Deletes a volume member from a protection group. After the member has been deleted, it is no longer protected by the group. Any protection group snapshots that were taken before the member was deleted are not affected. Deleting a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names and member_ids parameters represent the names or IDs of the volume. The group_names parameter, and either the member_names or member_ids parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_volumes_delete_with_http_info(authorization, x_request_id, group_ids, group_names, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_protection_groups_volumes_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_destroyed: Optional[StrictBool] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List protection groups with volume members # noqa: E501

Displays a list of protection groups that have volume members. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_volumes_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_ids, group_names, limit, member_destroyed, member_ids, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – Performs the operation on the unique group id specified. Provide multiple resource IDs in comma-separated format. The group_ids or names parameter is required, but they cannot be set together.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_destroyed (bool) – If true, returns only destroyed member objects. Returns an error if a name of a live member object is specified in the member_names query param. If false, returns only live member objects. Returns an error if a name of a destroyed member object is specified in the member_names query param.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupsVolumesGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_protection_groups_volumes_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a volume and add it to a protection group # noqa: E501

Creates a volume member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names and member_ids parameters represent the names or IDs of the volume. The group_names parameter, and either the member_names or member_ids parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_protection_groups_volumes_post_with_http_info(authorization, x_request_id, group_ids, group_names, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupsVolumesResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.realms_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.realms_api.RealmsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_realms_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, eradicate_contents: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete Realms # noqa: E501

Deletes realms that have been destroyed and are pending eradication. Eradicated realms cannot be recovered. Realms are destroyed using the PATCH method. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_realms_delete_with_http_info(authorization, x_request_id, eradicate_contents, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• eradicate_contents (bool) – Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups). This enables you to eradicate containers with contents.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_realms_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List realms # noqa: E501

Displays a list of realms. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_realms_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RealmGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_realms_patch_with_http_info(realm: RealmPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroy_contents: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, ignore_usage: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify realms # noqa: E501

Modifies realm details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_realms_patch_with_http_info(realm, authorization, x_request_id, destroy_contents, ids, ignore_usage, names, async_req=True)
>>> result = thread.get()

Parameters

• realm (RealmPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroy_contents (bool) – Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups), including eradicating containers with content.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• ignore_usage (bool) – Set to true to set a quota_limit that is lower than the existing usage. This ensures that no new volumes can be created until the existing usage drops below the quota_limit. If not specified, defaults to false.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RealmResponse, status_code(int), headers(HTTPHeaderDict))

api236_realms_performance_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List realm performance data # noqa: E501

Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all realms, displayed both by realm and as a total across all realms. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_realms_performance_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ContainerPerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_realms_post_with_http_info(names: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, realm: Optional[RealmPost] = None, **kwargs) → ApiResponse

Create realms # noqa: E501

Creates realms on the local array. Each realm must be given a name that is unique across the connected arrays. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_realms_post_with_http_info(names, authorization, x_request_id, realm, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• realm (RealmPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RealmResponse, status_code(int), headers(HTTPHeaderDict))

api236_realms_space_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List realm space information # noqa: E501

Displays provisioned size and storage consumption data for each realm on the local array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_realms_space_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RealmSpaceGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.remote_arrays_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.remote_arrays_api.RemoteArraysApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_remote_arrays_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, current_fleet_only: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List remote arrays # noqa: E501

Dispalys arrays in the current fleet, as well as arrays that the current array has existing replication connections to. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_arrays_get_with_http_info(authorization, x_request_id, continuation_token, current_fleet_only, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• current_fleet_only (bool) – If current_fleet_only is specified, then results will only show arrays from the same fleet to which the current array is a member of.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteArraysResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.remote_pods_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.remote_pods_api.RemotePodsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_remote_pods_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List remote pods # noqa: E501

Returns a list of pods that that are on connected arrays but not stretched to this array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_pods_get_with_http_info(authorization, x_request_id, filter, ids, limit, names, offset, on, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (List[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemotePodsResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.remote_protection_group_snapshots_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.remote_protection_group_snapshots_api.RemoteProtectionGroupSnapshotsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_remote_protection_group_snapshots_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, **kwargs) → ApiResponse

Delete a remote protection group snapshot # noqa: E501

Deletes a remote protection group snapshot that has been destroyed and is pending eradication. Eradicated remote protection group snapshots cannot be recovered. Remote protection group snapshots are destroyed using the PATCH method. The names parameter represents the name of the protection group snapshot. The on parameter represents the name of the offload target. The names and on parameters are required and must be used together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_protection_group_snapshots_delete_with_http_info(authorization, x_request_id, ids, names, on, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_remote_protection_group_snapshots_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List remote protection group snapshots # noqa: E501

Displays a list of remote protection group snapshots. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_protection_group_snapshots_get_with_http_info(authorization, x_request_id, destroyed, filter, ids, limit, names, offset, on, sort, source_ids, source_names, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (List[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteProtectionGroupSnapshotGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_remote_protection_group_snapshots_patch_with_http_info(remote_protection_group_snapshot: DestroyedPatchPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify a remote protection group snapshot # noqa: E501

Modifies a remote protection group snapshot, removing it from the offload target and destroying the snapshot. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_protection_group_snapshots_patch_with_http_info(remote_protection_group_snapshot, authorization, x_request_id, ids, names, on, async_req=True)
>>> result = thread.get()

Parameters

• remote_protection_group_snapshot (DestroyedPatchPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteProtectionGroupSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api236_remote_protection_group_snapshots_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, apply_retention: Optional[StrictBool] = None, convert_source_to_baseline: Optional[StrictBool] = None, for_replication: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, replicate: Optional[StrictBool] = None, replicate_now: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_protection_group_snapshot: Optional[RemoteProtectionGroupSnapshotPost] = None, **kwargs) → ApiResponse

Create remote protection group snapshot # noqa: E501

Creates remote protection group snapshots. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_protection_group_snapshots_post_with_http_info(authorization, x_request_id, allow_throttle, apply_retention, convert_source_to_baseline, for_replication, ids, names, on, replicate, replicate_now, source_ids, source_names, remote_protection_group_snapshot, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

• convert_source_to_baseline (bool) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

• for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

• replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• remote_protection_group_snapshot (RemoteProtectionGroupSnapshotPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteProtectionGroupSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api236_remote_protection_group_snapshots_test_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, apply_retention: Optional[StrictBool] = None, convert_source_to_baseline: Optional[StrictBool] = None, for_replication: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, replicate: Optional[StrictBool] = None, replicate_now: Optional[StrictBool] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, remote_protection_group_snapshot: Optional[RemoteProtectionGroupSnapshotPost] = None, **kwargs) → ApiResponse

Create an attempt to take remote protection group snapshot # noqa: E501

Create an attempt to take a remote protection group snapshot without actually taking it, to test if the snapshot can be successfully taken. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_protection_group_snapshots_test_post_with_http_info(authorization, x_request_id, allow_throttle, apply_retention, convert_source_to_baseline, for_replication, ids, names, on, replicate, replicate_now, source_ids, source_names, remote_protection_group_snapshot, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• apply_retention (bool) – If true, applies the local and remote retention policy to the snapshots.

• convert_source_to_baseline (bool) – Set to true to have the snapshot be eradicated when it is no longer baseline on source.

• for_replication (bool) – If true, destroys and eradicates the snapshot after 1 hour.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• replicate (bool) – If set to true, queues up and begins replicating to each allowed target after all earlier replication sessions for the same protection group have been completed to that target. The replicate and replicate_now parameters cannot be used together.

• replicate_now (bool) – If set to true, replicates the snapshots to each allowed target. The replicate and replicate_now parameters cannot be used together.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• remote_protection_group_snapshot (RemoteProtectionGroupSnapshotPost) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceWithIdPostResponse, status_code(int), headers(HTTPHeaderDict))

api236_remote_protection_group_snapshots_transfer_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List remote protection groups with transfer statistics # noqa: E501

Displays a list of remote protection groups and their transfer statistics. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_protection_group_snapshots_transfer_get_with_http_info(authorization, x_request_id, destroyed, filter, ids, limit, names, offset, on, sort, source_ids, source_names, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (List[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteProtectionGroupSnapshotTransferGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.remote_protection_groups_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.remote_protection_groups_api.RemoteProtectionGroupsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_remote_protection_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, **kwargs) → ApiResponse

Eradicate a remote protection group # noqa: E501

Eradicates a remote protection group that has been destroyed and is pending eradication. Eradicated remote protection groups cannot be recovered. Remote protection groups are destroyed through the PATCH method. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_protection_groups_delete_with_http_info(authorization, x_request_id, ids, names, on, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_remote_protection_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List remote protection groups # noqa: E501

Returns a list of remote protection groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_protection_groups_get_with_http_info(authorization, x_request_id, destroyed, filter, ids, limit, names, offset, on, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (List[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteProtectionGroupGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_remote_protection_groups_patch_with_http_info(remote_protection_group: RemoteProtectionGroup, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, **kwargs) → ApiResponse

Manage a remote protection group # noqa: E501

Configures the snapshot retention schedule of a remote protection group. Also destroys a remote protection group from the offload target. Before the remote protection group can be destroyed, the offload target must first be removed from the protection group via the source array. The on parameter represents the name of the offload target. The ids or names parameter and the on parameter are required and must be used together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_protection_groups_patch_with_http_info(remote_protection_group, authorization, x_request_id, ids, names, on, async_req=True)
>>> result = thread.get()

Parameters

• remote_protection_group (RemoteProtectionGroup) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteProtectionGroupResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.remote_volume_snapshots_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.remote_volume_snapshots_api.RemoteVolumeSnapshotsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_remote_volume_snapshots_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, replication_snapshot: Optional[StrictBool] = None, **kwargs) → ApiResponse

Delete a remote volume snapshot # noqa: E501

Deletes (eradicates) a remote volume snapshot that has been destroyed and is pending eradication. Eradicated remote volume snapshots cannot be recovered. Remote volume snapshots are destroyed through the PATCH method. The names parameter represents the name of the volume snapshot. The on parameter represents the name of the offload target. The names and on parameters are required and must be used together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_volume_snapshots_delete_with_http_info(authorization, x_request_id, names, on, replication_snapshot, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• replication_snapshot (bool) – If set to true, allow destruction/eradication of snapshots in use by replication. If set to false, allow destruction/eradication of snapshots not in use by replication. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_remote_volume_snapshots_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List remote volume snapshots # noqa: E501

Displays a list of remote volume snapshots. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_volume_snapshots_get_with_http_info(authorization, x_request_id, destroyed, filter, ids, limit, names, offset, on, sort, source_ids, source_names, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (List[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteVolumeSnapshotGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_remote_volume_snapshots_patch_with_http_info(remote_volume_snapshot: DestroyedPatchPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, on: Optional[StrictStr] = None, replication_snapshot: Optional[StrictBool] = None, **kwargs) → ApiResponse

Modify a remote volume snapshot # noqa: E501

Modifies a remote volume snapshot by destroying or recovering it from the offload target. The on parameter represents the name of the offload target. The names parameter and the on parameter are required and must be used together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_volume_snapshots_patch_with_http_info(remote_volume_snapshot, authorization, x_request_id, names, on, replication_snapshot, async_req=True)
>>> result = thread.get()

Parameters

• remote_volume_snapshot (DestroyedPatchPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• replication_snapshot (bool) – If set to true, allow destruction/eradication of snapshots in use by replication. If set to false, allow destruction/eradication of snapshots not in use by replication. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteVolumeSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api236_remote_volume_snapshots_post_with_http_info(remote_volume_snapshot: RemoteVolumeSnapshotPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, on: Optional[StrictStr] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a volume snapshot on a connected remote target or offload target # noqa: E501

Creates a volume snapshot on the specified connected remote target or offload target. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_volume_snapshots_post_with_http_info(remote_volume_snapshot, authorization, x_request_id, on, source_ids, source_names, async_req=True)
>>> result = thread.get()

Parameters

• remote_volume_snapshot (RemoteVolumeSnapshotPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteVolumeSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api236_remote_volume_snapshots_transfer_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, on: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List remote volume snapshots with transfer statistics # noqa: E501

Returns a list of remote volume snapshots and their transfer statistics. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_remote_volume_snapshots_transfer_get_with_http_info(authorization, x_request_id, destroyed, filter, ids, limit, names, offset, on, sort, source_ids, source_names, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• on (List[str]) – Performs the operation on the target name specified. Enter multiple target names in comma-separated format. For example, targetName01,targetName02.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(RemoteVolumeSnapshotTransferGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.saml2_sso_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.saml2_sso_api.SAML2SSOApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_sso_saml2_idps_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete SAML2 SSO configurations # noqa: E501

Deletes SAML2 SSO configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_sso_saml2_idps_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_sso_saml2_idps_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SAML2 SSO configurations # noqa: E501

Displays the SAML2 SSO service provider and identity provider configuration settings in the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_sso_saml2_idps_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(Saml2SsoGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_sso_saml2_idps_patch_with_http_info(idp: Saml2SsoPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify SAML2 SSO configurations # noqa: E501

Modifies one or more attributes of SAML2 SSO configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_sso_saml2_idps_patch_with_http_info(idp, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• idp (Saml2SsoPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(Saml2SsoResponse, status_code(int), headers(HTTPHeaderDict))

api236_sso_saml2_idps_post_with_http_info(names: ConstrainedListValue[StrictStr], idp: Saml2SsoPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create SAML2 SSO configurations # noqa: E501

Creates SAML2 SSO configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_sso_saml2_idps_post_with_http_info(names, idp, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• idp (Saml2SsoPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(Saml2SsoResponse, status_code(int), headers(HTTPHeaderDict))

api236_sso_saml2_idps_test_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List existing SAML2 SSO configurations # noqa: E501

Displays the existing SAML2 SSO configurations in the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_sso_saml2_idps_test_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceResponse, status_code(int), headers(HTTPHeaderDict))

api236_sso_saml2_idps_test_patch_with_http_info(idp: Saml2SsoPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify provided SAML2 SSO configurations # noqa: E501

Modifies the provided SAML2 SSO configurations. If the configurations with the specified ids or names exist, the provided configurations will overwrite the existing configurations, but will not be persisted in the array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_sso_saml2_idps_test_patch_with_http_info(idp, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• idp (Saml2SsoPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourcePatchResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.sessions_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.sessions_api.SessionsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_sessions_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List session data # noqa: E501

Displays session data for user login events performed in the Purity//FA GUI, CLI, and REST API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_sessions_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SessionGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.smis_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.smis_api.SMISApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_smi_s_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SMI-S settings # noqa: E501

Displays the SMI-S settings, including whether SLP and WBEM-HTTPS are enabled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_smi_s_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmisGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_smi_s_patch_with_http_info(smi_s: Smis, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify SLP and SMI-S # noqa: E501

Modifies the Service Location Protocol (SLP) and the SMI-S provider, enabling or disabling them. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_smi_s_patch_with_http_info(smi_s, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• smi_s (Smis) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmisResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.smtp_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.smtp_api.SMTPApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_smtp_servers_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SMTP server attributes # noqa: E501

Displays SMTP server attributes. Values include user_name, password, relay_host, sender_domain, sender_username, subject_prefix, body_prefix, encryption_mode, and name. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_smtp_servers_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmtpServerGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_smtp_servers_patch_with_http_info(smtp: SmtpServer, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify SMTP server attributes # noqa: E501

Modifies SMTP server attributes. Values include user_name, password, relay_host, sender_domain, sender_username, subject_prefix, body_prefix, encryption_mode, and name. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_smtp_servers_patch_with_http_info(smtp, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• smtp (SmtpServer) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SmtpServerResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.snmp_agents_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.snmp_agents_api.SNMPAgentsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_snmp_agents_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SNMP agent # noqa: E501

Displays the SNMP agent name and protocol attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_snmp_agents_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpAgentGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_snmp_agents_mib_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SNMP agent MIB text # noqa: E501

Displays the SNMP MIB text. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_snmp_agents_mib_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpAgentMibGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_snmp_agents_patch_with_http_info(snmp_agent: SnmpAgentPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify SNMP agent # noqa: E501

Modifies the name or the protocol attributes of the SNMP agent. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_snmp_agents_patch_with_http_info(snmp_agent, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• snmp_agent (SnmpAgentPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpAgentResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.snmp_managers_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.snmp_managers_api.SNMPManagersApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_snmp_managers_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete SNMP manager # noqa: E501

Deletes the SNMP manager object and stops communication with specified managers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_snmp_managers_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_snmp_managers_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SNMP managers # noqa: E501

Displays designated SNMP managers and their communication and security attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_snmp_managers_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpManagerGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_snmp_managers_patch_with_http_info(snmp_manager: SnmpManagerPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify SNMP manager # noqa: E501

Modifies the name or the protocol attributes of the specified SNMP manager. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_snmp_managers_patch_with_http_info(snmp_manager, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• snmp_manager (SnmpManagerPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpManagerResponse, status_code(int), headers(HTTPHeaderDict))

api236_snmp_managers_post_with_http_info(snmp_manager: SnmpManagerPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create SNMP manager # noqa: E501

Creates a Purity SNMP manager object that identifies a host (SNMP manager) and specifies the protocol attributes for communicating with it. Once a manager object is created, the transmission of SNMP traps is immediately enabled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_snmp_managers_post_with_http_info(snmp_manager, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• snmp_manager (SnmpManagerPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SnmpManagerResponse, status_code(int), headers(HTTPHeaderDict))

api236_snmp_managers_test_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List SNMP manager test results # noqa: E501

Displays SNMP manager test results (traps or informs). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_snmp_managers_test_get_with_http_info(authorization, x_request_id, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.software_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.software_api.SoftwareApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_software_bundle_get_with_http_info(x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List software-bundle # noqa: E501

Displays a list of software bundles. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_bundle_get_with_http_info(x_request_id, filter, ids, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareBundleGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_bundle_post_with_http_info(source: SoftwareBundlePost, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create software-bundle # noqa: E501

Creates and initiates a software bundle download. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_bundle_post_with_http_info(source, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• source (SoftwareBundlePost) – (required)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareBundleResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_check_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, software_names: Optional[ConstrainedListValue[StrictStr]] = None, software_versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a software check task # noqa: E501

Deletes a software check task specified by software name and version. The check task must be queued. If the check task is running or passed/failed then the task cannot be deleted. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_check_delete_with_http_info(authorization, x_request_id, software_names, software_versions, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• software_names (List[str]) – A comma-separated list of software names.

• software_versions (List[str]) – A comma-separated list of target software versions.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_software_check_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, software_names: Optional[ConstrainedListValue[StrictStr]] = None, software_versions: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List software check tasks # noqa: E501

Displays a list of software check tasks. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_check_get_with_http_info(authorization, x_request_id, filter, ids, limit, names, offset, software_names, software_versions, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• software_names (List[str]) – A comma-separated list of software names.

• software_versions (List[str]) – A comma-separated list of target software versions.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareChecksGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_check_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, software_names: Optional[ConstrainedListValue[StrictStr]] = None, software_versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a software check task # noqa: E501

Creates a software check task. If there are no previously queued or running software check tasks, the new task immediately starts. Otherwise, it is queued and starts once all previously queued or running software check tasks finish. To create a task, use a software name and version. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_check_post_with_http_info(authorization, x_request_id, software_names, software_versions, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• software_names (List[str]) – A comma-separated list of software names.

• software_versions (List[str]) – A comma-separated list of target software versions.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareChecksResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, software_versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a software package # noqa: E501

Deletes a software package specified by software name and version. A software package being used for an installation can be deleted if the installation is downloading, downloaded, aborted, or finished. If the software package is currently downloading, the download will be cancelled. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_delete_with_http_info(authorization, x_request_id, names, software_versions, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• software_versions (List[str]) – A comma-separated list of target software versions.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_software_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, versions: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

List software packages # noqa: E501

Displays a list of available software packages. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_get_with_http_info(authorization, x_request_id, filter, ids, limit, names, offset, sort, total_item_count, versions, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• versions (List[str]) – A comma-separated list of versions.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_installation_steps_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, software_installation_ids: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List software upgrade steps # noqa: E501

Displays a list of currently running and completed software upgrade steps. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_installation_steps_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, software_installation_ids, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• software_installation_ids (List[str]) – A comma-separated list of software installation IDs.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareInstallationStepsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_installations_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, software_ids: Optional[ConstrainedListValue[StrictStr]] = None, software_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List software upgrades # noqa: E501

Displays a list of software upgrades, including currently running and past upgrades. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_installations_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, software_ids, software_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• software_ids (List[str]) – A comma-separated list of software IDs.

• software_names (List[str]) – A comma-separated list of software names.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareInstallationsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_installations_patch_with_http_info(command: StrictStr, current_step_id: StrictStr, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, software_installations: Optional[SoftwareInstallationPatch] = None, **kwargs) → ApiResponse

Modify software upgrade # noqa: E501

Modifies a software upgrade by continuing, retrying, or aborting it. All override_checks are updated before the command being issued if add_override_checks is present. The override_checks parameter is valid when command is continue or retry. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_installations_patch_with_http_info(command, current_step_id, authorization, x_request_id, software_installations, async_req=True)
>>> result = thread.get()

Parameters

• command (str) – A user command that interacts with the upgrade. Commands may only be issued when the upgrade is paused. Valid values are continue, retry, and abort. The continue command continues a paused upgrade. The retry command retries the previous step. The abort command aborts the upgrade. (required)

• current_step_id (str) – The current step id of the installation. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• software_installations (SoftwareInstallationPatch) –

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareInstallationsResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_installations_post_with_http_info(software_ids: ConstrainedListValue[StrictStr], software_installations: SoftwareInstallationPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create a software upgrade # noqa: E501

Creates and initiates a software upgrade. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_installations_post_with_http_info(software_ids, software_installations, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• software_ids (List[str]) – A comma-separated list of software IDs. (required)

• software_installations (SoftwareInstallationPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareInstallationsResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_patches_catalog_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List available software patches # noqa: E501

Displays a list of available software patches. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_patches_catalog_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwarePatchesGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_patches_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List software patches # noqa: E501

Displays a list of software patches. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_patches_get_with_http_info(authorization, x_request_id, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwarePatchesGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_patches_post_with_http_info(name: StrictStr, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_ha_reduction: Optional[StrictBool] = None, **kwargs) → ApiResponse

Create a software patch # noqa: E501

Creates software patch download and installation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_patches_post_with_http_info(name, authorization, x_request_id, allow_ha_reduction, async_req=True)
>>> result = thread.get()

Parameters

• name (str) – Name of software patch to install (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_ha_reduction (bool) – If Software Patch has ha_reduction_required set to true, allow_ha_reduction must be set to true for Software Patch installation.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwarePatchesResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_post_with_http_info(software: SoftwarePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create a software package # noqa: E501

Creates a software package download. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_post_with_http_info(software, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• software (SoftwarePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareResponse, status_code(int), headers(HTTPHeaderDict))

api236_software_versions_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List software versions # noqa: E501

Displays a list of software versions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_software_versions_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SoftwareVersionsGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.subnets_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.subnets_api.SubnetsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_subnets_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete subnet # noqa: E501

Deletes subnets. A subnet can only be deleted if it has no interfaces. Interfaces must be removed by using the network-interfaces endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_subnets_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_subnets_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List subnets # noqa: E501

Displays a list of subnets with statuses and attributes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_subnets_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SubnetGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_subnets_patch_with_http_info(subnet: SubnetPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify subnet # noqa: E501

Modifies one or more specified subnet properties. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_subnets_patch_with_http_info(subnet, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• subnet (SubnetPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SubnetResponse, status_code(int), headers(HTTPHeaderDict))

api236_subnets_post_with_http_info(names: ConstrainedListValue[StrictStr], subnet: SubnetPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create subnet # noqa: E501

Creates a subnet with the specified parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_subnets_post_with_http_info(names, subnet, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• names (List[str]) – Performs the operation on the unique name specified. For example, name01. Enter multiple names in comma-separated format. (required)

• subnet (SubnetPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SubnetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.subscription_assets_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.subscription_assets_api.SubscriptionAssetsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_subscription_assets_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List subscription assets # noqa: E501

Displays information about subscription assets. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_subscription_assets_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SubscriptionAssetGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.subscriptions_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.subscriptions_api.SubscriptionsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_subscriptions_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List subscriptions # noqa: E501

Displays information about subscriptions. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_subscriptions_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SubscriptionGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.support_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.support_api.SupportApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_support_diagnostics_details_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List diagnostics details # noqa: E501

Displays the diagnostics tests details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_support_diagnostics_details_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SupportDiagnosticsDetailsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_support_diagnostics_settings_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List diagnostics tools version and last updated date # noqa: E501

Displays diagnostics tools version and last updated date. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_support_diagnostics_settings_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SupportDiagnosticsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_support_diagnostics_settings_patch_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, purity_default: Optional[StrictBool] = None, **kwargs) → ApiResponse

Update diagnostics tools # noqa: E501

Update diagnostics tools from downloaded bundle. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_support_diagnostics_settings_patch_with_http_info(authorization, x_request_id, purity_default, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• purity_default (bool) – Set diagnostics tool to default version.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SupportDiagnosticsResponse, status_code(int), headers(HTTPHeaderDict))

api236_support_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List connection paths # noqa: E501

Displays connection paths between the current array and each connected array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_support_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SupportGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_support_patch_with_http_info(support: SupportPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Create connection path # noqa: E501

Creates a connection path from the array to another array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_support_patch_with_http_info(support, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• support (SupportPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SupportResponse, status_code(int), headers(HTTPHeaderDict))

api236_support_test_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, test_type: Optional[StrictStr] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List Pure Storage Support connection data # noqa: E501

Displays information about whether the array can connect to Pure Storage Support by establishing a secure shell or secure HTTP connection and verifies that messages can be exchanged. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_support_test_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, test_type, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• test_type (str) – Specifies the type of test. Valid values are all, phonehome, and remote-assist. If not specified, defaults to all.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.syslog_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.syslog_api.SyslogApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_syslog_servers_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete syslog server # noqa: E501

Deletes a configured syslog server and stops forwarding syslog messages. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_syslog_servers_delete_with_http_info(authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_syslog_servers_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List syslog servers # noqa: E501

Displays a list of configured syslog servers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_syslog_servers_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_syslog_servers_patch_with_http_info(syslog_server: SyslogServer, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify syslog server # noqa: E501

Modifies the URI and services of a configured syslog server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_syslog_servers_patch_with_http_info(syslog_server, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• syslog_server (SyslogServer) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerResponse, status_code(int), headers(HTTPHeaderDict))

api236_syslog_servers_post_with_http_info(syslog_server: SyslogServer, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create syslog server # noqa: E501

Creates a new syslog server. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_syslog_servers_post_with_http_info(syslog_server, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• syslog_server (SyslogServer) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerResponse, status_code(int), headers(HTTPHeaderDict))

api236_syslog_servers_settings_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List syslog settings # noqa: E501

Displays syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_syslog_servers_settings_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerSettingsGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_syslog_servers_settings_patch_with_http_info(syslog_server_settings: SyslogServerSettings, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Modify syslog settings # noqa: E501

Modifies syslog settings. Values include continuation_token, items, more_items_remaining, and total_item_count. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_syslog_servers_settings_patch_with_http_info(syslog_server_settings, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• syslog_server_settings (SyslogServerSettings) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(SyslogServerSettingsResponse, status_code(int), headers(HTTPHeaderDict))

api236_syslog_servers_test_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List syslog server test results # noqa: E501

Displays syslog server test results, which indicate whether the syslog is working and configured correctly. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_syslog_servers_test_get_with_http_info(authorization, x_request_id, filter, limit, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.vchost_connections_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.vchost_connections_api.VchostConnectionsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_vchost_connections_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, all_vchosts: Optional[StrictBool] = None, protocol_endpoint_ids: Optional[ConstrainedListValue[StrictStr]] = None, protocol_endpoint_names: Optional[ConstrainedListValue[StrictStr]] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete the vchost-connection between a protocol endpoint and its vchost # noqa: E501

Deletes the vchost-connection between a protocol endpoint and its vchost. The storage container represented by the protocol endpoint will no longer be visible to the vCenter represented by the vchost. One of the protocol_endpoint_names or protocol_endpoint_ids query parameters, and one of the vchost_names or vchost_ids query parameters are required. But if all_vchosts is set to true, vchost_names and vchost_ids should not be specified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchost_connections_delete_with_http_info(authorization, x_request_id, all_vchosts, protocol_endpoint_ids, protocol_endpoint_names, vchost_ids, vchost_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• all_vchosts (bool) – If set to true, the storage container represented by the protocol endpoint is accessible to all vchosts. Users should not specify vchost_ids or vchost_names in the request. If set to false, the storage container represented by the protocol endpoint is only accessible to the vchosts that have explicit vchost-connections with the protocol endpoint. Users need to specify vchost_ids or vchost_names in the request.

• protocol_endpoint_ids (List[str]) – A comma-separated list of protocol endpoint IDs. Performs the operation on the protocol endpoints specified. For example, peid01,peid02. Cannot be used in conjunction with protocol_endpoint_names. If the list contains more than one value, then vchost_ids or vchost_names must have exactly one value.

• protocol_endpoint_names (List[str]) – A comma-separated list of protocol endpoint names. Performs the operation on the protocol endpoints specified. For example, pe01,pe02. Cannot be used in conjunction with protocol_endpoint_ids. If the list contains more than one value, then vchost_ids or vchost_names must have exactly one value.

• vchost_ids (List[str]) – A comma-separated list of vchost IDs. Performs the operation on the vchosts specified. For example, vchostid01,vchostid02. Cannot be used in conjunction with vchost_names. If the list contains more than one value, then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

• vchost_names (List[str]) – A comma-separated list of vchost names. Performs the operation on the vchosts specified. For example, vchost01,vchost02. Cannot be used in conjunction with vchost_ids. If the list contains more than one value, then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_vchost_connections_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, all_vchosts: Optional[StrictBool] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, protocol_endpoint_ids: Optional[ConstrainedListValue[StrictStr]] = None, protocol_endpoint_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

List the vchost-connections between protocol endpoint and vchost. # noqa: E501

Displays a list of vchost-connections between the protocol endpoint and vchost. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchost_connections_get_with_http_info(authorization, x_request_id, all_vchosts, continuation_token, filter, limit, offset, protocol_endpoint_ids, protocol_endpoint_names, sort, total_item_count, vchost_ids, vchost_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• all_vchosts (bool) – If set to true, the storage container represented by the protocol endpoint is accessible to all vchosts. Users should not specify vchost_ids or vchost_names in the request. If set to false, the storage container represented by the protocol endpoint is only accessible to the vchosts that have explicit vchost-connections with the protocol endpoint. Users need to specify vchost_ids or vchost_names in the request.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• protocol_endpoint_ids (List[str]) – A comma-separated list of protocol endpoint IDs. Performs the operation on the protocol endpoints specified. For example, peid01,peid02. Cannot be used in conjunction with protocol_endpoint_names. If the list contains more than one value, then vchost_ids or vchost_names must have exactly one value.

• protocol_endpoint_names (List[str]) – A comma-separated list of protocol endpoint names. Performs the operation on the protocol endpoints specified. For example, pe01,pe02. Cannot be used in conjunction with protocol_endpoint_ids. If the list contains more than one value, then vchost_ids or vchost_names must have exactly one value.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• vchost_ids (List[str]) – A comma-separated list of vchost IDs. Performs the operation on the vchosts specified. For example, vchostid01,vchostid02. Cannot be used in conjunction with vchost_names. If the list contains more than one value, then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

• vchost_names (List[str]) – A comma-separated list of vchost names. Performs the operation on the vchosts specified. For example, vchost01,vchost02. Cannot be used in conjunction with vchost_ids. If the list contains more than one value, then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VchostConnectionGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_vchost_connections_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, all_vchosts: Optional[StrictBool] = None, allow_stretched_multi_vchost: Optional[StrictBool] = None, protocol_endpoint_ids: Optional[ConstrainedListValue[StrictStr]] = None, protocol_endpoint_names: Optional[ConstrainedListValue[StrictStr]] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a vchost-connection between protocol endpoint and vchost. # noqa: E501

Creates a vchost-connection between protocol endpoint and vchost. Each vchost is associated with a vCenter. Each protocol endpoint is associated with a storage container. A vchost-connection makes the storage container accessible to the vCenter when the vCenter attempts to mount the container. One of protocol_endpoint_names or protocol_endpoint_ids query parameters and one of vchost_names or vchost_ids query parameters are required. But if all_vchosts is set to true, vchost_names and vchost_ids should not be specified. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchost_connections_post_with_http_info(authorization, x_request_id, all_vchosts, allow_stretched_multi_vchost, protocol_endpoint_ids, protocol_endpoint_names, vchost_ids, vchost_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• all_vchosts (bool) – If set to true, the storage container represented by the protocol endpoint is accessible to all vchosts. Users should not specify vchost_ids or vchost_names in the request. If set to false, the storage container represented by the protocol endpoint is only accessible to the vchosts that have explicit vchost-connections with the protocol endpoint. Users need to specify vchost_ids or vchost_names in the request.

• allow_stretched_multi_vchost (bool) – If set to true, users are allowed to create a new vchost-connection to a stretched container that already has a vchost-connection. In principle, a stretched container can only have one vchost-connection at a time.

• protocol_endpoint_ids (List[str]) – A comma-separated list of protocol endpoint IDs. Performs the operation on the protocol endpoints specified. For example, peid01,peid02. Cannot be used in conjunction with protocol_endpoint_names. If the list contains more than one value, then vchost_ids or vchost_names must have exactly one value.

• protocol_endpoint_names (List[str]) – A comma-separated list of protocol endpoint names. Performs the operation on the protocol endpoints specified. For example, pe01,pe02. Cannot be used in conjunction with protocol_endpoint_ids. If the list contains more than one value, then vchost_ids or vchost_names must have exactly one value.

• vchost_ids (List[str]) – A comma-separated list of vchost IDs. Performs the operation on the vchosts specified. For example, vchostid01,vchostid02. Cannot be used in conjunction with vchost_names. If the list contains more than one value, then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

• vchost_names (List[str]) – A comma-separated list of vchost names. Performs the operation on the vchosts specified. For example, vchost01,vchost02. Cannot be used in conjunction with vchost_ids. If the list contains more than one value, then protocol_endpoint_ids or protocol_endpoint_names must have exactly one value.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VchostConnectionResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.vchosts_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.vchosts_api.VchostsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_vchosts_certificates_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a vchost certificate # noqa: E501

Deletes an existing vchost certificate. The ids query parameter alone, or the certificate_names query parameter together with one of vchost_names or vchost_ids, is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_certificates_delete_with_http_info(authorization, x_request_id, certificate_names, ids, vchost_ids, vchost_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_names (List[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_ids (List[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• vchost_names (List[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_vchosts_certificates_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

List vchost certificates # noqa: E501

Displays certificates that are attached to configured vchosts on at least one endpoint. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_certificates_get_with_http_info(authorization, x_request_id, certificate_names, continuation_token, filter, ids, limit, offset, sort, total_item_count, vchost_ids, vchost_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_names (List[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• vchost_ids (List[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• vchost_names (List[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VchostCertificateGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_vchosts_certificates_patch_with_http_info(certificate: VchostCertificatePatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, certificate_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a vchost certificate # noqa: E501

Modifies an existing vchost certificate. The ids query parameter alone, or the certificate_names query parameter together with one of vchost_names or vchost_ids, is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_certificates_patch_with_http_info(certificate, authorization, x_request_id, certificate_names, ids, vchost_ids, vchost_names, async_req=True)
>>> result = thread.get()

Parameters

• certificate (VchostCertificatePatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• certificate_names (List[str]) – The names of one or more certificates. Enter multiple names in comma-separated format. For example, cert01,cert02.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_ids (List[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• vchost_names (List[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VchostCertificateResponse, status_code(int), headers(HTTPHeaderDict))

api236_vchosts_certificates_post_with_http_info(certificate: VchostCertificatePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a vchost certificate # noqa: E501

Creates an association between a certificate and vchost on one or more endpoints. The vchost_names or vchost_ids query parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_certificates_post_with_http_info(certificate, authorization, x_request_id, vchost_ids, vchost_names, async_req=True)
>>> result = thread.get()

Parameters

• certificate (VchostCertificatePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• vchost_ids (List[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• vchost_names (List[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VchostCertificateResponse, status_code(int), headers(HTTPHeaderDict))

api236_vchosts_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a vchost # noqa: E501

Deletes an existing vchost. The names or ids query parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_vchosts_endpoints_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, endpoints: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a vchost endpoint # noqa: E501

Deletes an existing vchost endpoint The ids query parameter alone, or the endpoints query parameter together with one of vchost_names or vchost_ids, is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_endpoints_delete_with_http_info(authorization, x_request_id, endpoints, ids, vchost_ids, vchost_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• endpoints (List[str]) – Performs the operation on the unique endpoints specified. Enter multiple endpoints in a comma-separated format.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_ids (List[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• vchost_names (List[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_vchosts_endpoints_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, endpoints: Optional[ConstrainedListValue[StrictStr]] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

List vchost endpoints # noqa: E501

Displays a list of vchost endpoints with their associated vchosts and certificates. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_endpoints_get_with_http_info(authorization, x_request_id, continuation_token, endpoints, filter, ids, limit, offset, sort, total_item_count, vchost_ids, vchost_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• endpoints (List[str]) – Performs the operation on the unique endpoints specified. Enter multiple endpoints in a comma-separated format.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• vchost_ids (List[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• vchost_names (List[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VchostEndpointGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_vchosts_endpoints_patch_with_http_info(endpoint: VchostEndpointPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, endpoints: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a vchost endpoint # noqa: E501

Modifies an existing vchost endpoint. The ids query parameter alone, or the endpoints query parameter together with one of vchost_names or vchost_ids, is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_endpoints_patch_with_http_info(endpoint, authorization, x_request_id, endpoints, ids, vchost_ids, vchost_names, async_req=True)
>>> result = thread.get()

Parameters

• endpoint (VchostEndpointPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• endpoints (List[str]) – Performs the operation on the unique endpoints specified. Enter multiple endpoints in a comma-separated format.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• vchost_ids (List[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• vchost_names (List[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VchostEndpointResponse, status_code(int), headers(HTTPHeaderDict))

api236_vchosts_endpoints_post_with_http_info(endpoint: VchostEndpointPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, vchost_ids: Optional[ConstrainedListValue[StrictStr]] = None, vchost_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a vchost endpoint # noqa: E501

Creates a vchost endpoint. Either the vchost_names or vchost_ids query parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_endpoints_post_with_http_info(endpoint, authorization, x_request_id, vchost_ids, vchost_names, async_req=True)
>>> result = thread.get()

Parameters

• endpoint (VchostEndpointPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• vchost_ids (List[str]) – Performs the operation on the unique vchost IDs specified. Enter multiple vchost IDs in a comma-separated format. For example, vchostid01,vchostid02.

• vchost_names (List[str]) – Performs the operation on the unique vchost name specified. Enter multiple names in a comma-separated format. For example, vchost01,vchost02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VchostEndpointResponse, status_code(int), headers(HTTPHeaderDict))

api236_vchosts_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List vchosts # noqa: E501

Displays a list of vchosts. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_get_with_http_info(authorization, x_request_id, continuation_token, filter, ids, limit, names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VchostGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_vchosts_patch_with_http_info(vchost: VchostPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a vchost # noqa: E501

Modifies an existing vchost. The names or ids query parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_patch_with_http_info(vchost, authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• vchost (VchostPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VchostResponse, status_code(int), headers(HTTPHeaderDict))

api236_vchosts_post_with_http_info(vchost: VchostPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a vchost # noqa: E501

Creates a vchost. The names query parameter is required. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_vchosts_post_with_http_info(vchost, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• vchost (VchostPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VchostResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.virtual_machines_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.virtual_machines_api.VirtualMachinesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_virtual_machine_snapshots_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, vm_ids: Optional[ConstrainedListValue[StrictStr]] = None, vm_type: Optional[StrictStr] = None, **kwargs) → ApiResponse

List Virtual Machine Snapshots # noqa: E501

Displays a list of virtual machine snapshots, including those pending eradication. If vm_type is vvol, the recovery_context in the response will represent a protection group snapshot containing the virtual machine. This must be used as the source in the POST /virtual-machine method when recovering or overwriting a virtual machine from a snapshot. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_virtual_machine_snapshots_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, offset, sort, total_item_count, vm_ids, vm_type, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• vm_ids (List[str]) – Performs the operation on the unique virtual machine IDs specified. Enter multiple resource IDs in a comma-separated format.

• vm_type (str) – The type of virtual machine. The only valid value is vvol.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VirtualMachineGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_virtual_machine_volume_snapshots_get_with_http_info(vm_ids: ConstrainedListValue[StrictStr], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, vm_type: Optional[StrictStr] = None, **kwargs) → ApiResponse

List Virtual Machine Volume Snapshots # noqa: E501

Displays a list of virtual machine volume snapshots, including those pending eradication. If vm_type is vvol, the recover_context in the response will represent a protection group snapshot containing the virtual machine volume. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_virtual_machine_volume_snapshots_get_with_http_info(vm_ids, authorization, x_request_id, continuation_token, destroyed, filter, limit, offset, sort, total_item_count, vm_type, async_req=True)
>>> result = thread.get()

Parameters

• vm_ids (List[str]) – Performs the operation on the unique virtual machine IDs specified. Enter multiple resource IDs in a comma-separated format. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• vm_type (str) – The type of virtual machine. The only valid value is vvol.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VirtualMachineVolumeSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api236_virtual_machines_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, vm_ids: Optional[ConstrainedListValue[StrictStr]] = None, vm_type: Optional[StrictStr] = None, **kwargs) → ApiResponse

List Virtual Machines # noqa: E501

Displays a list of virtual machines, including those pending eradication. If vm_type is vvol, the recovery_context in the response will represent the most recent snapshot of the config vVol. This must be used as the source in the PATCH method when recovering a virtual machine from the destroyed state. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_virtual_machines_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, limit, offset, sort, total_item_count, vm_ids, vm_type, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• vm_ids (List[str]) – Performs the operation on the unique virtual machine IDs specified. Enter multiple virtual machine IDs in a comma-separated format.

• vm_type (str) – The type of virtual machine. The only valid value is vvol.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VirtualMachineGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_virtual_machines_patch_with_http_info(virtual_machine: VirtualMachinePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, **kwargs) → ApiResponse

Update a virtual machine # noqa: E501

Updates a virtual machine, recovering it from the destroyed state. If the virtual machine is of type vvol, the source property of the request body must be a recovery_context value retrieved from the GET /virtual-machines endpoint. If recovering the virtual machine will cause a conflict with an existing virtual machine, the operation will fail. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_virtual_machines_patch_with_http_info(virtual_machine, authorization, x_request_id, async_req=True)
>>> result = thread.get()

Parameters

• virtual_machine (VirtualMachinePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VirtualMachineResponse, status_code(int), headers(HTTPHeaderDict))

api236_virtual_machines_post_with_http_info(virtual_machine: VirtualMachinePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, overwrite: Optional[StrictBool] = None, **kwargs) → ApiResponse

Create a virtual machine # noqa: E501

Creates one or more virtual machines from a protection group snapshot. If the virtual machine is of type vvol, the source property of the request body must be a recovery_context value retrieved from the GET /virtual-machine-snapshots endpoint. If overwrite is specified, an existing virtual machine will have its volumes overwritten by the snapshot. Otherwise, a new virtual machine will be created from the snapshot. If creating the new virtual machine will cause a conflict with an existing virtual machine, the operation will fail. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_virtual_machines_post_with_http_info(virtual_machine, authorization, x_request_id, overwrite, async_req=True)
>>> result = thread.get()

Parameters

• virtual_machine (VirtualMachinePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VirtualMachineResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.volume_groups_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.volume_groups_api.VolumeGroupsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_volume_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, eradicate_contents: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a volume group # noqa: E501

Deletes a volume group that has been destroyed and is pending eradication. Eradicated volume groups cannot be recovered. Volume groups are destroyed through the PATCH method. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_groups_delete_with_http_info(authorization, x_request_id, eradicate_contents, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• eradicate_contents (bool) – Set to true to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups). This enables you to eradicate containers with contents.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_volume_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volume groups # noqa: E501

Displays a list of volume groups, including those pending eradication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_groups_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumeGroupGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volume_groups_patch_with_http_info(volume_group: VolumeGroupPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroy_contents: Optional[StrictBool] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Modify a volume group # noqa: E501

Modifies a volume group. You can rename, destroy, recover, or set QoS limits for a volume group. To rename a volume group, set name to the new name. To destroy a volume group, set destroyed=true. To recover a volume group that has been destroyed and is pending eradication, set destroyed=false. Sets the bandwidth and IOPs limits of a volume group through the respective bandwidth_limit and iops_limit parameter. The ids or names parameter is required, but they cannot be set together. Sets the priority adjustment for a volume group using the priority_adjustment_operator and priority_adjustment_value fields. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_groups_patch_with_http_info(volume_group, authorization, x_request_id, destroy_contents, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• volume_group (VolumeGroupPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroy_contents (bool) – Set to true to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups), including eradicating containers with content.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumeGroupResponse, status_code(int), headers(HTTPHeaderDict))

api236_volume_groups_performance_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volume group performance data # noqa: E501

Returns real-time and historical performance data, real-time latency data, and average I/O sizes for each volume group and and as a total of all volume groups across the entire array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_groups_performance_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourcePerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volume_groups_post_with_http_info(volume_group: VolumeGroupPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a volume group # noqa: E501

Creates a volume group. The volume group itself does not contain any meaningful content; instead, it acts as a container that is used to organize volumes. Once a volume group has been created, volumes can be created inside the volume group or moved into and out of the volume group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_groups_post_with_http_info(volume_group, authorization, x_request_id, names, async_req=True)
>>> result = thread.get()

Parameters

• volume_group (VolumeGroupPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumeGroupResponse, status_code(int), headers(HTTPHeaderDict))

api236_volume_groups_space_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volume group space information # noqa: E501

Displays the provisioned size and physical storage consumption data for each volume group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_groups_space_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourceSpaceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volume_groups_volumes_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volume groups with volumes # noqa: E501

Returns a list of volume groups that contain volumes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_groups_volumes_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_ids, group_names, limit, member_ids, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.volume_snapshots_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.volume_snapshots_api.VolumeSnapshotsApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_volume_snapshots_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, replication_snapshot: Optional[StrictBool] = None, **kwargs) → ApiResponse

Delete a volume snapshot # noqa: E501

Deletes a volume snapshot that has been destroyed and is pending eradication. Eradicated volume snapshots cannot be recovered. Volume snapshots are destroyed by using the PATCH method. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_snapshots_delete_with_http_info(authorization, x_request_id, ids, names, replication_snapshot, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• replication_snapshot (bool) – If set to true, allow destruction/eradication of snapshots in use by replication. If set to false, allow destruction/eradication of snapshots not in use by replication. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_volume_snapshots_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volume snapshots # noqa: E501

Displays a list of volume snapshots, including those pending eradication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_snapshots_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, source_ids, source_names, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumeSnapshotGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volume_snapshots_patch_with_http_info(volume_snapshot: VolumeSnapshotPatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, replication_snapshot: Optional[StrictBool] = None, **kwargs) → ApiResponse

Modify a volume snapshot # noqa: E501

Modifies a volume snapshot by renaming, destroying, or recovering it. To rename the suffix of a volume snapshot, set name to the new suffix name. To recover a volume snapshot that has been destroyed and is pending eradication, set destroyed=true. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_snapshots_patch_with_http_info(volume_snapshot, authorization, x_request_id, ids, names, replication_snapshot, async_req=True)
>>> result = thread.get()

Parameters

• volume_snapshot (VolumeSnapshotPatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• replication_snapshot (bool) – If set to true, allow destruction/eradication of snapshots in use by replication. If set to false, allow destruction/eradication of snapshots not in use by replication. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumeSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api236_volume_snapshots_post_with_http_info(volume_snapshot: VolumeSnapshotPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, on: Optional[StrictStr] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a volume snapshot # noqa: E501

Creates a point-in-time snapshot of the contents of a volume. The source_ids or source_names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_snapshots_post_with_http_info(volume_snapshot, authorization, x_request_id, allow_throttle, on, source_ids, source_names, async_req=True)
>>> result = thread.get()

Parameters

• volume_snapshot (VolumeSnapshotPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumeSnapshotResponse, status_code(int), headers(HTTPHeaderDict))

api236_volume_snapshots_tags_batch_put_with_http_info(tag: ConstrainedListValue[Tag], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Update tags # noqa: E501

Updates tags. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_snapshots_tags_batch_put_with_http_info(tag, authorization, x_request_id, resource_ids, resource_names, async_req=True)
>>> result = thread.get()

Parameters

• tag (List[Tag]) – A list of tags to be created or modified. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TagResponse, status_code(int), headers(HTTPHeaderDict))

api236_volume_snapshots_tags_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete tags # noqa: E501

Deletes specified tags. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_snapshots_tags_delete_with_http_info(authorization, x_request_id, keys, namespaces, resource_ids, resource_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_volume_snapshots_tags_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resource_destroyed: Optional[StrictBool] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List tags # noqa: E501

Displays the list of tags. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_snapshots_tags_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, namespaces, offset, resource_destroyed, resource_ids, resource_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• namespaces (List[str]) – A comma-separated list of namespaces.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resource_destroyed (bool) – If set to true, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the resource_names query parameter. If set to false, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the resource_names query parameter.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TagGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volume_snapshots_test_post_with_http_info(volume_snapshot: VolumeSnapshotPost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, on: Optional[StrictStr] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create the volume snapshot path # noqa: E501

Creates the volume snapshot path without actually taking a volume snapshot. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_snapshots_test_post_with_http_info(volume_snapshot, authorization, x_request_id, allow_throttle, on, source_ids, source_names, async_req=True)
>>> result = thread.get()

Parameters

• volume_snapshot (VolumeSnapshotPost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_throttle (bool) – If set to true, allows snapshot to fail if array health is not optimal.

• on (str) – Performs the operation on the target name specified. For example, targetName01.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourcePostResponse, status_code(int), headers(HTTPHeaderDict))

api236_volume_snapshots_transfer_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, source_ids: Optional[ConstrainedListValue[StrictStr]] = None, source_names: Optional[ConstrainedListValue[StrictStr]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volume snapshots with transfer statistics # noqa: E501

Displays a list of volume snapshots and their transfer statistics. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volume_snapshots_transfer_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, source_ids, source_names, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• source_ids (List[str]) – Performs the operation on the source ID specified. Enter multiple source IDs in comma-separated format.

• source_names (List[str]) – Performs the operation on the source name specified. Enter multiple source names in comma-separated format. For example, name01,name02.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumeSnapshotTransferGetResponse, status_code(int), headers(HTTPHeaderDict))

pypureclient.flasharray.FA_2_36.api.volumes_api module

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

class pypureclient.flasharray.FA_2_36.api.volumes_api.VolumesApi(api_client: Optional[ApiClient] = None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api236_volumes_batch_post_with_http_info(volume: ConstrainedListValue[VolumeBatchPost], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, overwrite: Optional[StrictBool] = None, with_default_protection: Optional[StrictBool] = None, **kwargs) → ApiResponse

Create or copy volumes and upsert tags # noqa: E501

Creates or copies a list of virtual storage volumes. Volumes of different sizes, vgroups, and tag upsertions can be copied this way. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_batch_post_with_http_info(volume, authorization, x_request_id, allow_throttle, overwrite, with_default_protection, async_req=True)
>>> result = thread.get()

Parameters

• volume (List[VolumeBatchPost]) – A list of volumes to be created or copied. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• with_default_protection (bool) – If specified as true, the initial protection of the newly created volumes will be the union of the container default protection configuration and add_to_protection_group_names. If specified as false, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by add_to_protection_group_names. If not specified, defaults to true.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumesBatchResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_batch_test_post_with_http_info(volume: ConstrainedListValue[VolumeBatchPost], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, allow_throttle: Optional[StrictBool] = None, overwrite: Optional[StrictBool] = None, with_default_protection: Optional[StrictBool] = None, **kwargs) → ApiResponse

Create a dry run attempt to copy multiple volumes. # noqa: E501

Creates a dry run attempt to see if copying a list of virtual storage volumes would succeed. No virtual volumes are actually copied or created in this process. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_batch_test_post_with_http_info(volume, authorization, x_request_id, allow_throttle, overwrite, with_default_protection, async_req=True)
>>> result = thread.get()

Parameters

• volume (List[VolumeBatchPost]) – A list of volumes to be copied. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• with_default_protection (bool) – If specified as true, the initial protection of the newly created volumes will be the union of the container default protection configuration and add_to_protection_group_names. If specified as false, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by add_to_protection_group_names. If not specified, defaults to true.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceWithIdPostResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a volume # noqa: E501

Deletes a volume that has been destroyed and is pending eradication. Eradicated volumes cannot be recovered. Volumes are destroyed using the PATCH method. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_delete_with_http_info(authorization, x_request_id, ids, names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_volumes_diff_get_with_http_info(block_size: StrictInt, segment_length: StrictInt, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, base_id: Optional[StrictStr] = None, base_name: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, next_allocated_block_hint: Optional[StrictBool] = None, offset: Optional[ConstrainedIntValue] = None, segment_offset: Optional[StrictInt] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volume diffs # noqa: E501

Displays block differences for the specified volumes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_diff_get_with_http_info(block_size, segment_length, authorization, x_request_id, base_id, base_name, filter, ids, limit, names, next_allocated_block_hint, offset, segment_offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• block_size (int) – Granularity at which to compare, in bytes. Must be a multiple of 512. (required)

• segment_length (int) – Length of the segment, in bytes, to compare. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• base_id (str) – ID of the volume or volume snapshot that the diff comparison is based on. If a base volume or volume snapshot is not specified, all mapped blocks for the volume or volume snapshot are displayed. The base_name or base_id parameter is required, but they cannot be set together.

• base_name (str) – Name of the volume or volume snapshot that the diff comparison is based on. If a base volume or volume snapshot is not specified, all mapped blocks for the volume or volume snapshot are displayed. The base_name or base_id parameter is required, but they cannot be set together.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• next_allocated_block_hint (bool) – If set to true, appends offset of the next allocated block in bytes for the volume specified in names or ids to the output items. base_name or base_id must not be specified if this is set to true. If not specified, defaults to false.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• segment_offset (int) – Absolute offset, in bytes, of the segment to compare. Must be a multiple of block_size.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumesDiffGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volumes # noqa: E501

Displays a list of volumes, including those pending eradication. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_get_with_http_info(authorization, x_request_id, continuation_token, destroyed, filter, ids, limit, names, offset, sort, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumeGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_patch_with_http_info(volume: VolumePatch, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, add_to_protection_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, add_to_protection_group_names: Optional[ConstrainedListValue[StrictStr]] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, remove_from_protection_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, remove_from_protection_group_names: Optional[ConstrainedListValue[StrictStr]] = None, truncate: Optional[StrictBool] = None, **kwargs) → ApiResponse

Modify a volume # noqa: E501

Modifies a volume by renaming, destroying, or resizing it. To rename a volume, set name to the new name. To destroy a volume, set destroyed=true. To recover a volume that has been destroyed and is pending eradication, set destroyed=false. Set the bandwidth and IOPs limits of a volume through the respective bandwidth_limit and iops_limit parameter. This moves the volume into a pod or volume group through the respective pod or volume_group parameter. The ids or names parameter is required, but they cannot be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_patch_with_http_info(volume, authorization, x_request_id, add_to_protection_group_ids, add_to_protection_group_names, ids, names, remove_from_protection_group_ids, remove_from_protection_group_names, truncate, async_req=True)
>>> result = thread.get()

Parameters

• volume (VolumePatch) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• add_to_protection_group_ids (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple ids in comma-separated format.

• add_to_protection_group_names (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple names in a comma-separated format.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• remove_from_protection_group_ids (List[str]) – The volumes will be removed from the specified protection groups in the source pod or array along with the move. This can only be used when moving volumes across pods and arrays and must include all protection groups that the volumes are members of before the move. Enter multiple ids in a comma-separated format.

• remove_from_protection_group_names (List[str]) – The volumes will be removed from the specified protection groups in the source pod or array along with the move. This can only be used when moving volumes across pods and arrays and must include all protection groups that the volumes are members of before the move. Enter multiple names in a comma-separated format.

• truncate (bool) – If set to true, reduces the size of a volume during a volume resize operation. When a volume is truncated, Purity automatically takes an undo snapshot, providing a 24-hour window during which the previous contents can be retrieved. After truncating a volume, its provisioned size can be subsequently increased, but the data in truncated sectors cannot be retrieved. If set to false or not set at all and the volume is being reduced in size, the volume copy operation fails. Required if the provisioned parameter is set to a volume size that is smaller than the original size.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumeResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_performance_by_array_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volume performance data by array # noqa: E501

Return real-time and historical performance data, real-time latency data, and average I/O size data. The data returned is for each volume on the current array and for each volume on any remote arrays that are visible to the current array. The data is grouped by individual volumes and as a total across all volumes on each array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_performance_by_array_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourcePerformanceByArrayGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_performance_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volume performance data # noqa: E501

Returns real-time and historical performance data, real-time latency data, and average I/O sizes for each volume and and as a total of all volumes across the entire array. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_performance_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ResourcePerformanceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_post_with_http_info(volume: VolumePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, add_to_protection_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, add_to_protection_group_names: Optional[ConstrainedListValue[StrictStr]] = None, allow_throttle: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, overwrite: Optional[StrictBool] = None, with_default_protection: Optional[StrictBool] = None, **kwargs) → ApiResponse

Create a volume # noqa: E501

Creates one or more virtual storage volumes of the specified size. If provisioned is not specified, the size of the new volume defaults to 1 MB. The names query parameter is required. The add_to_protection_group_names query parameter specifies a list of protection group names that will compose the initial protection for the volume. The with_default_protection query parameter specifies whether to use the container default protection configuration for the volume. The add_to_protection_group_names and with_default_protection query parameters cannot be provided when overwrite is true. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_post_with_http_info(volume, authorization, x_request_id, add_to_protection_group_ids, add_to_protection_group_names, allow_throttle, names, overwrite, with_default_protection, async_req=True)
>>> result = thread.get()

Parameters

• volume (VolumePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• add_to_protection_group_ids (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple ids in comma-separated format.

• add_to_protection_group_names (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple names in a comma-separated format.

• allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• with_default_protection (bool) – If specified as true, the initial protection of the newly created volumes will be the union of the container default protection configuration and add_to_protection_group_names. If specified as false, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by add_to_protection_group_names. If not specified, defaults to true.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumeResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_protection_groups_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete a volume from a protection group # noqa: E501

Deletes a volume member from a protection group. After the member has been deleted, it is no longer protected by the group. Any protection group snapshots that were taken before the member was deleted are not affected. Deleting a member from a protection group does not delete the member from the array, and the member can be added back to the protection group at any time. The group_names parameter represents the name of the protection group, and the member_names and member_ids parameters represent the names or IDs of the volume. The group_names and only one of member_names or member_ids parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_protection_groups_delete_with_http_info(authorization, x_request_id, group_ids, group_names, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_volumes_protection_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_destroyed: Optional[StrictBool] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volumes that are members of protection groups # noqa: E501

Displays a list of volume members that belong to one or more protection groups. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_protection_groups_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_ids, group_names, limit, member_destroyed, member_ids, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_destroyed (bool) – If true, returns only destroyed member objects. Returns an error if a name of a live member object is specified in the member_names query param. If false, returns only live member objects. Returns an error if a name of a destroyed member object is specified in the member_names query param.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupsVolumesGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_protection_groups_post_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Create a volume and add it to a protection group # noqa: E501

Creates a volume member and adds it to a protection group. Members that are already in the protection group are not affected. For asynchronous replication, only members of the same type can belong to a protection group. The group_names parameter represents the name of the protection group, and the member_names and member_ids parameters represent the names or IDs of the volume. The group_names and only one of member_names or member_ids parameters are required and must be set together. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_protection_groups_post_with_http_info(authorization, x_request_id, group_ids, group_names, member_ids, member_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(ProtectionGroupsVolumesResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_space_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, destroyed: Optional[StrictBool] = None, end_time: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resolution: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, start_time: Optional[StrictInt] = None, total_item_count: Optional[StrictBool] = None, total_only: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volume space information # noqa: E501

Displays the provisioned size and physical storage consumption data for each volume. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_space_get_with_http_info(authorization, x_request_id, destroyed, end_time, filter, ids, limit, names, offset, resolution, sort, start_time, total_item_count, total_only, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• destroyed (bool) – If set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds.

• end_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• ids (List[str]) – Performs the operation on the unique resource IDs specified. Enter multiple resource IDs in comma-separated format. The ids or names parameter is required, but they cannot be set together.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resolution (int) – The number of milliseconds between samples of historical data. For array-wide performance metrics (/arrays/performance endpoint), valid values are 1000 (1 second), 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For performance metrics on storage objects (<object name>/performance endpoint), such as volumes, valid values are 30000 (30 seconds), 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). For space metrics, (<object name>/space endpoint), valid values are 300000 (5 minutes), 1800000 (30 minutes), 7200000 (2 hours), 28800000 (8 hours), and 86400000 (24 hours). Include the start_time parameter to display the performance data starting at the specified start time. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the end_time parameter to display the performance data until the specified end time. If end_time`is not specified, the end time will default to the current time. If the `resolution parameter is not specified but either the start_time or end_time parameter is, then resolution will default to the lowest valid resolution.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• start_time (int) – Displays historical performance data for the specified time window, where start_time is the beginning of the time window, and end_time is the end of the time window. The start_time and end_time parameters are specified in milliseconds since the UNIX epoch. If start_time is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If end_time`is not specified, the end time will default to the current time. Include the `resolution parameter to display the performance data at the specified resolution. If not specified, resolution defaults to the lowest valid resolution.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• total_only (bool) – If set to true, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If total_only=true, the items list will be empty.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(VolumeSpaceGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_tags_batch_put_with_http_info(tag: ConstrainedListValue[Tag], authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Update tags # noqa: E501

Updates tags. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_tags_batch_put_with_http_info(tag, authorization, x_request_id, resource_ids, resource_names, async_req=True)
>>> result = thread.get()

Parameters

• tag (List[Tag]) – A list of tags to be created or, if already existing, updated. (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TagResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_tags_delete_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, keys: Optional[ConstrainedListValue[StrictStr]] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, **kwargs) → ApiResponse

Delete tags # noqa: E501

Deletes specified tags. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_tags_delete_with_http_info(authorization, x_request_id, keys, namespaces, resource_ids, resource_names, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• keys (List[str]) – A comma-separated list of tag keys.

• namespaces (List[str]) – A comma-separated list of namespaces. Only one namespace is allowed per delete request.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

None

api236_volumes_tags_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[ConstrainedIntValue] = None, namespaces: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, resource_destroyed: Optional[StrictBool] = None, resource_ids: Optional[ConstrainedListValue[StrictStr]] = None, resource_names: Optional[ConstrainedListValue[StrictStr]] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List tags # noqa: E501

Displays the list of tags. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_tags_get_with_http_info(authorization, x_request_id, continuation_token, filter, limit, namespaces, offset, resource_destroyed, resource_ids, resource_names, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• namespaces (List[str]) – A comma-separated list of namespaces.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• resource_destroyed (bool) – If set to true, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the resource_names query parameter. If set to false, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the resource_names query parameter.

• resource_ids (List[str]) – A comma-separated list of resource IDs. The resource_ids or resource_names parameter is required, but they cannot be set together.

• resource_names (List[str]) – A comma-separated list of resource names. The resource_ids or resource_names parameter is required, but they cannot be set together.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TagGetResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_test_post_with_http_info(volume: VolumePost, authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, add_to_protection_group_ids: Optional[ConstrainedListValue[StrictStr]] = None, add_to_protection_group_names: Optional[ConstrainedListValue[StrictStr]] = None, allow_throttle: Optional[StrictBool] = None, names: Optional[ConstrainedListValue[StrictStr]] = None, overwrite: Optional[StrictBool] = None, with_default_protection: Optional[StrictBool] = None, **kwargs) → ApiResponse

Create a dry run attempt to copy a volume # noqa: E501

Creates a dry run attempt to see if copying a volume would succeed. No virtual volumes are actually copied or created in this process. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_test_post_with_http_info(volume, authorization, x_request_id, add_to_protection_group_ids, add_to_protection_group_names, allow_throttle, names, overwrite, with_default_protection, async_req=True)
>>> result = thread.get()

Parameters

• volume (VolumePost) – (required)

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• add_to_protection_group_ids (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple ids in comma-separated format.

• add_to_protection_group_names (List[str]) – The volumes will be added to the specified protection groups along with creation or movement across pods and array. When a volume is moved, the specified protection groups must be in the target pod or array. Enter multiple names in a comma-separated format.

• allow_throttle (bool) – If set to true, allows operation to fail if array health is not optimal.

• names (List[str]) – Performs the operation on the unique name specified. Enter multiple names in comma-separated format. For example, name01,name02.

• overwrite (bool) – If set to true, overwrites an existing object during an object copy operation. If set to false or not set at all and the target name is an existing object, the copy operation fails. Required if the source body parameter is set and the source overwrites an existing object during the copy operation.

• with_default_protection (bool) – If specified as true, the initial protection of the newly created volumes will be the union of the container default protection configuration and add_to_protection_group_names. If specified as false, the default protection of the container will not be applied automatically. The initial protection of the newly created volumes will be configured by add_to_protection_group_names. If not specified, defaults to true.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(TestResultWithResourceWithIdPostResponse, status_code(int), headers(HTTPHeaderDict))

api236_volumes_volume_groups_get_with_http_info(authorization: Optional[StrictStr] = None, x_request_id: Optional[StrictStr] = None, continuation_token: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, group_ids: Optional[ConstrainedListValue[StrictStr]] = None, group_names: Optional[ConstrainedListValue[StrictStr]] = None, limit: Optional[ConstrainedIntValue] = None, member_ids: Optional[ConstrainedListValue[StrictStr]] = None, member_names: Optional[ConstrainedListValue[StrictStr]] = None, offset: Optional[ConstrainedIntValue] = None, sort: Optional[ConstrainedListValue[ConstrainedStrValue]] = None, total_item_count: Optional[StrictBool] = None, **kwargs) → ApiResponse

List volumes that are in volume groups # noqa: E501

Returns a list of volumes that are in a volume group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.api236_volumes_volume_groups_get_with_http_info(authorization, x_request_id, continuation_token, filter, group_ids, group_names, limit, member_ids, member_names, offset, sort, total_item_count, async_req=True)
>>> result = thread.get()

Parameters

• authorization (str) – Access token (in JWT format) required to use any API endpoint (except /oauth2, /login, and /logout)

• x_request_id (str) – Supplied by client during request or generated by server.

• continuation_token (str) – A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set continuation_token to the system-generated token taken from the x-next-token header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the limit and continuation_token query parameters.

• filter (str) – Narrows down the results to only the response objects that satisfy the filter criteria.

• group_ids (List[str]) – A comma-separated list of group IDs.

• group_names (List[str]) – Performs the operation on the unique group name specified. Examples of groups include host groups, pods, protection groups, and volume groups. Enter multiple names in comma-separated format. For example, hgroup01,hgroup02.

• limit (int) – Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set limit=0. The total number of resources is returned as a total_item_count value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size.

• member_ids (List[str]) – Performs the operation on the unique member IDs specified. Enter multiple member IDs in comma-separated format. The member_ids or member_names parameter is required, but they cannot be set together.

• member_names (List[str]) – Performs the operation on the unique member name specified. Examples of members include volumes, hosts, host groups, and directories. Enter multiple names in comma-separated format. For example, vol01,vol02.

• offset (int) – The starting position based on the results of the query in relation to the full set of response objects returned.

• sort (List[str]) – Returns the response objects in the order specified. Set sort to the name in the response by which to sort. Sorting can be performed on any of the names in the response, and the objects can be sorted in ascending or descending order. By default, the response objects are sorted in ascending order. To sort in descending order, append the minus sign (-) to the name. A single request can be sorted on multiple objects. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple names, list the names as comma-separated values.

• total_item_count (bool) – If set to true, the total_item_count matching the specified query parameters is calculated and returned in the response. If set to false, the total_item_count is null in the response. This may speed up queries where the total_item_count is large. If not specified, defaults to false.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type

tuple(MemberGetResponse, status_code(int), headers(HTTPHeaderDict))

Module contents

FlashArray REST API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: 2.36 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.